From 988158d79f4dc63d5c99bbfabec936eeeabc39a7 Mon Sep 17 00:00:00 2001 From: Drew Powers Date: Fri, 22 Sep 2023 20:19:55 -0600 Subject: [PATCH] Fix all parameters optional --- .changeset/chilled-swans-hunt.md | 5 + .../examples/digital-ocean-api.ts | 60 +- .../examples/github-api-next.ts | 1037 ++--- .../examples/github-api-next.yaml | 508 ++- .../openapi-typescript/examples/github-api.ts | 566 +-- .../examples/github-api.yaml | 497 ++- .../examples/octokit-ghes-3.6-diff-to-api.ts | 20 +- .../openapi-typescript/examples/stripe-api.ts | 1420 ++++++- .../examples/stripe-api.yaml | 3619 ++++++++++++++--- .../src/transform/components-object.ts | 8 +- .../src/transform/operation-object.ts | 16 +- .../test/components-object.test.ts | 2 +- .../openapi-typescript/test/index.test.ts | 2 +- .../test/operation-object.test.ts | 97 +- .../test/paths-object.test.ts | 6 +- 15 files changed, 5746 insertions(+), 2117 deletions(-) create mode 100644 .changeset/chilled-swans-hunt.md diff --git a/.changeset/chilled-swans-hunt.md b/.changeset/chilled-swans-hunt.md new file mode 100644 index 000000000..291a3c8b3 --- /dev/null +++ b/.changeset/chilled-swans-hunt.md @@ -0,0 +1,5 @@ +--- +"openapi-typescript": patch +--- + +Fix all parameters optional diff --git a/packages/openapi-typescript/examples/digital-ocean-api.ts b/packages/openapi-typescript/examples/digital-ocean-api.ts index c67299321..7ca99daae 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api.ts +++ b/packages/openapi-typescript/examples/digital-ocean-api.ts @@ -754,7 +754,7 @@ export interface external { * 1-Click application data, each of which will contain the the slug and type for the 1-Click. */ "resources/1-clicks/oneClicks_list.yml": { - parameters: { + parameters?: { query?: { type?: external["resources/1-clicks/parameters.yml"]["oneClicks_type"]; }; @@ -905,7 +905,7 @@ export interface external { * @description This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default. */ "resources/actions/actions_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -1112,7 +1112,7 @@ export interface external { * @description Create a new app by submitting an app specification. For documentation on app specifications (`AppSpec` objects), please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/). */ "resources/apps/apps_create.yml": { - parameters: { + parameters?: { header?: { Accept?: external["resources/apps/parameters.yml"]["accept"]; "Content-Type"?: external["resources/apps/parameters.yml"]["content-type"]; @@ -1497,7 +1497,7 @@ export interface external { * @description List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app. */ "resources/apps/apps_list.yml": { - parameters: { + parameters?: { query?: { page?: external["shared/parameters.yml"]["page"]; per_page?: external["shared/parameters.yml"]["per_page"]; @@ -3277,7 +3277,7 @@ export interface external { * @description To retrieve a list of all invoices, send a GET request to `/v2/customers/my/invoices`. */ "resources/billing/invoices_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -3716,7 +3716,7 @@ export interface external { * @description To list all of the CDN endpoints available on your account, send a GET request to `/v2/cdn/endpoints`. */ "resources/cdn/cdn_list_endpoints.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -3959,7 +3959,7 @@ export interface external { * @description To list all of the certificates available on your account, send a GET request to `/v2/certificates`. */ "resources/certificates/certificates_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -4795,7 +4795,7 @@ export interface external { * The embedded `maintenance_window` object will contain information about any scheduled maintenance for the database cluster. */ "resources/databases/databases_list_clusters.yml": { - parameters: { + parameters?: { query?: { tag_name?: external["resources/databases/parameters.yml"]["tag_name"]; }; @@ -6783,7 +6783,7 @@ export interface external { * @description To retrieve a list of all of the domains in your account, send a GET request to `/v2/domains`. */ "resources/domains/domains_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -7110,7 +7110,7 @@ export interface external { * - `snapshot` */ "resources/droplets/dropletActions_post_byTag.yml": { - parameters: { + parameters?: { query?: { tag_name?: external["resources/droplets/parameters.yml"]["droplet_tag_name"]; }; @@ -7603,7 +7603,7 @@ export interface external { * `/v2/droplets?tag_name=$TAG_NAME`. */ "resources/droplets/droplets_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -8683,7 +8683,7 @@ export interface external { * @description To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`. */ "resources/firewalls/firewalls_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -8945,7 +8945,7 @@ export interface external { * @description To list all of the floating IPs available on your account, send a GET request to `/v2/floating_ips`. */ "resources/floating_ips/floatingIPs_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -9804,7 +9804,7 @@ export interface external { * To list all images assigned to a specific tag, include the `tag_name` query parameter set to the name of the tag in your GET request. For example, `/v2/images?tag_name=$TAG_NAME`. */ "resources/images/images_list.yml": { - parameters: { + parameters?: { query?: { type?: external["resources/images/parameters.yml"]["type"]; private?: external["resources/images/parameters.yml"]["private"]; @@ -10443,7 +10443,7 @@ export interface external { * to `/v2/kubernetes/clusters`. */ "resources/kubernetes/kubernetes_list_clusters.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -11508,7 +11508,7 @@ export interface external { * to `/v2/load_balancers`. */ "resources/load_balancers/loadBalancers_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -12372,7 +12372,7 @@ export interface external { * @description Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to `/v2/monitoring/alerts`. */ "resources/monitoring/monitoring_list_alertPolicy.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -12787,7 +12787,7 @@ export interface external { * @description To list all your projects, send a GET request to `/v2/projects`. */ "resources/projects/projects_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -13023,7 +13023,7 @@ export interface external { * The response will be a JSON object with a key called `regions`. The value of this will be an array of `region` objects, each of which will contain the standard region attributes. */ "resources/regions/regions_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -13447,7 +13447,7 @@ export interface external { * credentials that expire after one hour. */ "resources/registry/registry_get_dockerCredentials.yml": { - parameters: { + parameters?: { query?: { expiry_seconds?: external["resources/registry/parameters.yml"]["registry_expiry_seconds"]; read_write?: external["resources/registry/parameters.yml"]["registry_read_write"]; @@ -14036,7 +14036,7 @@ export interface external { * @description To list all of the reserved IPs available on your account, send a GET request to `/v2/reserved_ips`. */ "resources/reserved_ips/reservedIPs_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -14284,7 +14284,7 @@ export interface external { * The response will be a JSON object with a key called `sizes`. The value of this will be an array of `size` objects each of which contain the standard size attributes. */ "resources/sizes/sizes_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -14457,7 +14457,7 @@ export interface external { * query parameter set to `volume`. For example, `/v2/snapshots?resource_type=volume`. */ "resources/snapshots/snapshots_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -14597,7 +14597,7 @@ export interface external { * @description To list all of the keys in your account, send a GET request to `/v2/account/keys`. The response will be a JSON object with a key set to `ssh_keys`. The value of this will be an array of ssh_key objects, each of which contains the standard ssh_key attributes. */ "resources/ssh_keys/sshKeys_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -14868,7 +14868,7 @@ export interface external { * @description To list all of your tags, you can send a GET request to `/v2/tags`. */ "resources/tags/tags_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -15090,7 +15090,7 @@ export interface external { * @description To list all of the Uptime checks on your account, send a GET request to `/v2/uptime/checks`. */ "resources/uptime/list_checks.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -15694,7 +15694,7 @@ export interface external { * | region | Set to the slug representing the region where the volume is located | */ "resources/volumes/volumeActions_post.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; @@ -15740,7 +15740,7 @@ export interface external { * No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. */ "resources/volumes/volumes_delete_byName.yml": { - parameters: { + parameters?: { query?: { name?: external["resources/volumes/parameters.yml"]["volume_name"]; region?: external["shared/parameters.yml"]["region"]; @@ -15807,7 +15807,7 @@ export interface external { * It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`. */ "resources/volumes/volumes_list.yml": { - parameters: { + parameters?: { query?: { name?: external["resources/volumes/parameters.yml"]["volume_name"]; region?: external["shared/parameters.yml"]["region"]; @@ -16128,7 +16128,7 @@ export interface external { * @description To list all of the VPCs on your account, send a GET request to `/v2/vpcs`. */ "resources/vpcs/vpcs_list.yml": { - parameters: { + parameters?: { query?: { per_page?: external["shared/parameters.yml"]["per_page"]; page?: external["shared/parameters.yml"]["page"]; diff --git a/packages/openapi-typescript/examples/github-api-next.ts b/packages/openapi-typescript/examples/github-api-next.ts index 09475ce20..e66fe8d0d 100644 --- a/packages/openapi-typescript/examples/github-api-next.ts +++ b/packages/openapi-typescript/examples/github-api-next.ts @@ -8284,7 +8284,9 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * - * **Note**: This event will not occur when more than three tags are created at once. + * **Notes**: + * - This event will not occur when more than three tags are created at once. + * - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. */ post: operations["create"]; }; @@ -10002,7 +10004,7 @@ export interface webhooks { "push": { /** * This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, - * when a branch is deleted, when a tag is deleted, or when a repository is cloned. To subscribe to only branch + * when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch * and tag deletions, use the [`delete`](#delete) webhook event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. @@ -20754,6 +20756,36 @@ export interface components { id: number; key: string; }; + /** + * Enterprise + * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured + * on an enterprise account or an organization that's part of an enterprise account. For more information, + * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." + */ + "enterprise-webhooks": { + /** @description A short description of the enterprise. */ + description?: string | null; + /** Format: uri */ + html_url: string; + /** + * Format: uri + * @description The enterprise's website URL. + */ + website_url?: string | null; + /** @description Unique identifier of the enterprise */ + id: number; + node_id: string; + /** @description The name of the enterprise. */ + name: string; + /** @description The slug url identifier for the enterprise. */ + slug: string; + /** Format: date-time */ + created_at: string | null; + /** Format: date-time */ + updated_at: string | null; + /** Format: uri */ + avatar_url: string; + }; /** * Simple Installation * @description The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -21583,7 +21615,7 @@ export interface components { "webhook-branch-protection-configuration-disabled": { /** @enum {string} */ action: "disabled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -21593,7 +21625,7 @@ export interface components { "webhook-branch-protection-configuration-enabled": { /** @enum {string} */ action: "enabled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -21603,7 +21635,7 @@ export interface components { "webhook-branch-protection-rule-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -21657,7 +21689,7 @@ export interface components { "webhook-branch-protection-rule-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -21737,7 +21769,7 @@ export interface components { from: "off" | "non_admins" | "everyone"; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -22099,7 +22131,7 @@ export interface components { */ url: string; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -22340,7 +22372,7 @@ export interface components { */ url: string; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -22581,7 +22613,7 @@ export interface components { */ url: string; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -22707,7 +22739,7 @@ export interface components { }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ @@ -22842,7 +22874,7 @@ export interface components { }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ @@ -22939,7 +22971,7 @@ export interface components { }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ @@ -23076,7 +23108,7 @@ export interface components { }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ @@ -23169,7 +23201,7 @@ export interface components { }) | null; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ @@ -23255,7 +23287,7 @@ export interface components { }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ @@ -23350,7 +23382,7 @@ export interface components { url?: string; }) | null; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -23360,7 +23392,7 @@ export interface components { "webhook-create": { /** @description The repository's current description. */ description: string | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The name of the repository's default branch (usually `main`). */ master_branch: string; @@ -23379,7 +23411,7 @@ export interface components { }; /** delete event */ "webhook-delete": { - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The pusher type for the event. Can be either `user` or a deploy key. */ @@ -23401,7 +23433,7 @@ export interface components { alert: components["schemas"]["dependabot-alert"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; @@ -23412,7 +23444,7 @@ export interface components { alert: components["schemas"]["dependabot-alert"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; @@ -23423,7 +23455,7 @@ export interface components { alert: components["schemas"]["dependabot-alert"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; @@ -23434,7 +23466,7 @@ export interface components { alert: components["schemas"]["dependabot-alert"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; @@ -23445,7 +23477,7 @@ export interface components { alert: components["schemas"]["dependabot-alert"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; @@ -23456,7 +23488,7 @@ export interface components { alert: components["schemas"]["dependabot-alert"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; @@ -23467,7 +23499,7 @@ export interface components { alert: components["schemas"]["dependabot-alert"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; @@ -23475,7 +23507,7 @@ export interface components { "webhook-deploy-key-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ key: { @@ -23498,7 +23530,7 @@ export interface components { "webhook-deploy-key-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ key: { @@ -23717,7 +23749,7 @@ export interface components { /** Format: uri */ url: string; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -24065,7 +24097,7 @@ export interface components { url?: string; }; comment?: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -24437,7 +24469,7 @@ export interface components { url?: string; }; comment?: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -24788,7 +24820,7 @@ export interface components { "webhook-deployment-review-requested": { /** @enum {string} */ action: "requested"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; environment: string; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; @@ -25589,7 +25621,7 @@ export interface components { /** Format: uri */ url: string; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -25969,7 +26001,7 @@ export interface components { }) | null; }; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -25997,7 +26029,7 @@ export interface components { }; }; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -26008,7 +26040,7 @@ export interface components { /** @enum {string} */ action: "closed"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -26088,7 +26120,7 @@ export interface components { }) | null; }; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -26168,7 +26200,7 @@ export interface components { }) | null; }; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -26253,7 +26285,7 @@ export interface components { }) | null; }; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -26456,7 +26488,7 @@ export interface components { url?: string; }; }); - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -26467,7 +26499,7 @@ export interface components { /** @enum {string} */ action: "deleted"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -26486,7 +26518,7 @@ export interface components { }; }; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -26497,7 +26529,7 @@ export interface components { /** @enum {string} */ action: "labeled"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** Label */ label: { @@ -26524,7 +26556,7 @@ export interface components { /** @enum {string} */ action: "locked"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -26535,7 +26567,7 @@ export interface components { /** @enum {string} */ action: "pinned"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -26546,7 +26578,7 @@ export interface components { /** @enum {string} */ action: "reopened"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -26561,7 +26593,7 @@ export interface components { new_repository: components["schemas"]["repository-webhooks"]; }; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -26652,7 +26684,7 @@ export interface components { /** @enum {string} */ action: "unlabeled"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** Label */ label: { @@ -26679,7 +26711,7 @@ export interface components { /** @enum {string} */ action: "unlocked"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -26690,7 +26722,7 @@ export interface components { /** @enum {string} */ action: "unpinned"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -26701,7 +26733,7 @@ export interface components { * @description A user forks a repository. */ "webhook-fork": { - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */ forkee: ({ /** @@ -27044,7 +27076,7 @@ export interface components { "webhook-github-app-authorization-revoked": { /** @enum {string} */ action: "revoked"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -27052,7 +27084,7 @@ export interface components { }; /** gollum event */ "webhook-gollum": { - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The pages that were updated. */ @@ -27082,7 +27114,7 @@ export interface components { "webhook-installation-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description An array of repository objects that the installation can access. */ @@ -27140,7 +27172,7 @@ export interface components { "webhook-installation-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description An array of repository objects that the installation can access. */ @@ -27162,7 +27194,7 @@ export interface components { "webhook-installation-new-permissions-accepted": { /** @enum {string} */ action: "new_permissions_accepted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description An array of repository objects that the installation can access. */ @@ -27184,7 +27216,7 @@ export interface components { "webhook-installation-repositories-added": { /** @enum {string} */ action: "added"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description An array of repository objects, which were added to the installation. */ @@ -27258,7 +27290,7 @@ export interface components { "webhook-installation-repositories-removed": { /** @enum {string} */ action: "removed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description An array of repository objects, which were added to the installation. */ @@ -27332,7 +27364,7 @@ export interface components { "webhook-installation-suspend": { /** @enum {string} */ action: "suspend"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description An array of repository objects that the installation can access. */ @@ -27399,7 +27431,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -27410,7 +27442,7 @@ export interface components { "webhook-installation-unsuspend": { /** @enum {string} */ action: "unsuspend"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description An array of repository objects that the installation can access. */ @@ -27517,7 +27549,7 @@ export interface components { url?: string; }) | null; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: ({ @@ -28131,7 +28163,7 @@ export interface components { url?: string; }) | null; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: ({ @@ -28752,7 +28784,7 @@ export interface components { url?: string; }) | null; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: ({ @@ -29321,7 +29353,7 @@ export interface components { /** Format: uri */ url?: string; }) | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -29744,7 +29776,7 @@ export interface components { * @enum {string} */ action: "closed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: ({ @@ -30220,7 +30252,7 @@ export interface components { "webhook-issues-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -30640,7 +30672,7 @@ export interface components { "webhook-issues-demilestoned": { /** @enum {string} */ action: "demilestoned"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; issue: ({ /** @enum {string|null} */ @@ -31266,7 +31298,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -31702,7 +31734,7 @@ export interface components { "webhook-issues-labeled": { /** @enum {string} */ action: "labeled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -32138,7 +32170,7 @@ export interface components { "webhook-issues-locked": { /** @enum {string} */ action: "locked"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; issue: ({ /** @enum {string|null} */ @@ -32614,7 +32646,7 @@ export interface components { "webhook-issues-milestoned": { /** @enum {string} */ action: "milestoned"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; issue: ({ /** @enum {string|null} */ @@ -33876,7 +33908,7 @@ export interface components { watchers_count: number; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -34296,7 +34328,7 @@ export interface components { "webhook-issues-pinned": { /** @enum {string} */ action: "pinned"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -34716,7 +34748,7 @@ export interface components { "webhook-issues-reopened": { /** @enum {string} */ action: "reopened"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; issue: ({ /** @enum {string|null} */ @@ -35845,7 +35877,7 @@ export interface components { web_commit_signoff_required?: boolean; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -36305,7 +36337,7 @@ export interface components { /** Format: uri */ url?: string; }) | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -36725,7 +36757,7 @@ export interface components { "webhook-issues-unlabeled": { /** @enum {string} */ action: "unlabeled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -37161,7 +37193,7 @@ export interface components { "webhook-issues-unlocked": { /** @enum {string} */ action: "unlocked"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; issue: ({ /** @enum {string|null} */ @@ -37636,7 +37668,7 @@ export interface components { "webhook-issues-unpinned": { /** @enum {string} */ action: "unpinned"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -38056,7 +38088,7 @@ export interface components { "webhook-label-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** Label */ label: { @@ -38082,7 +38114,7 @@ export interface components { "webhook-label-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** Label */ label: { @@ -38123,7 +38155,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** Label */ label: { @@ -38150,7 +38182,7 @@ export interface components { /** @enum {string} */ action: "cancelled"; effective_date: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; marketplace_purchase: ({ account: { @@ -38239,7 +38271,7 @@ export interface components { /** @enum {string} */ action: "changed"; effective_date: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; marketplace_purchase: ({ account: { @@ -38328,7 +38360,7 @@ export interface components { /** @enum {string} */ action: "pending_change"; effective_date: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; marketplace_purchase: ({ account: { @@ -38417,7 +38449,7 @@ export interface components { /** @enum {string} */ action: "pending_change_cancelled"; effective_date: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; marketplace_purchase: ({ account: { @@ -38483,7 +38515,7 @@ export interface components { /** @enum {string} */ action: "purchased"; effective_date: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; marketplace_purchase: ({ account: { @@ -38577,7 +38609,7 @@ export interface components { to: "write" | "admin" | "read"; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** User */ member: ({ @@ -38635,7 +38667,7 @@ export interface components { to?: string | null; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** User */ member: ({ @@ -38682,7 +38714,7 @@ export interface components { "webhook-member-removed": { /** @enum {string} */ action: "removed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** User */ member: ({ @@ -38729,7 +38761,7 @@ export interface components { "webhook-membership-added": { /** @enum {string} */ action: "added"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** User */ member: ({ @@ -38879,7 +38911,7 @@ export interface components { "webhook-membership-removed": { /** @enum {string} */ action: "removed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** User */ member: ({ @@ -39052,7 +39084,7 @@ export interface components { "webhook-meta-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ hook: { active: boolean; @@ -39082,7 +39114,7 @@ export interface components { "webhook-milestone-closed": { /** @enum {string} */ action: "closed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Milestone @@ -39163,7 +39195,7 @@ export interface components { "webhook-milestone-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Milestone @@ -39244,7 +39276,7 @@ export interface components { "webhook-milestone-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Milestone @@ -39340,7 +39372,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Milestone @@ -39421,7 +39453,7 @@ export interface components { "webhook-milestone-opened": { /** @enum {string} */ action: "opened"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Milestone @@ -39539,7 +39571,7 @@ export interface components { /** Format: uri */ url?: string; }) | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -39586,7 +39618,7 @@ export interface components { /** Format: uri */ url?: string; }) | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -39596,7 +39628,7 @@ export interface components { "webhook-organization-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Membership @@ -39655,7 +39687,7 @@ export interface components { "webhook-organization-member-added": { /** @enum {string} */ action: "member_added"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Membership @@ -39714,7 +39746,7 @@ export interface components { "webhook-organization-member-invited": { /** @enum {string} */ action: "member_invited"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The invitation for the user or email if the action is `member_invited`. */ invitation: { @@ -39815,7 +39847,7 @@ export interface components { "webhook-organization-member-removed": { /** @enum {string} */ action: "member_removed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Membership @@ -39879,7 +39911,7 @@ export interface components { from?: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Membership @@ -39957,7 +39989,7 @@ export interface components { "webhook-package-published": { /** @enum {string} */ action: "published"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description Information about the package. */ @@ -40214,7 +40246,7 @@ export interface components { "webhook-package-updated": { /** @enum {string} */ action: "updated"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description Information about the package. */ @@ -40463,7 +40495,7 @@ export interface components { /** Format: uri */ url: string; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; id: number; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -40568,7 +40600,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ @@ -40638,7 +40670,7 @@ export interface components { "webhook-project-card-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ @@ -40708,7 +40740,7 @@ export interface components { "webhook-project-card-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ @@ -40783,7 +40815,7 @@ export interface components { from: string | null; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ @@ -40858,7 +40890,7 @@ export interface components { from: number; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; project_card: ({ @@ -40959,7 +40991,7 @@ export interface components { "webhook-project-closed": { /** @enum {string} */ action: "closed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project */ @@ -41033,7 +41065,7 @@ export interface components { "webhook-project-column-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Column */ @@ -41062,7 +41094,7 @@ export interface components { "webhook-project-column-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Column */ @@ -41096,7 +41128,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Column */ @@ -41125,7 +41157,7 @@ export interface components { "webhook-project-column-moved": { /** @enum {string} */ action: "moved"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Column */ @@ -41154,7 +41186,7 @@ export interface components { "webhook-project-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project */ @@ -41228,7 +41260,7 @@ export interface components { "webhook-project-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project */ @@ -41313,7 +41345,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project */ @@ -41387,7 +41419,7 @@ export interface components { "webhook-project-reopened": { /** @enum {string} */ action: "reopened"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project */ @@ -41624,7 +41656,7 @@ export interface components { }; /** public event */ "webhook-public": { - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -41671,7 +41703,7 @@ export interface components { /** Format: uri */ url?: string; }) | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -42860,7 +42892,7 @@ export interface components { "webhook-pull-request-auto-merge-disabled": { /** @enum {string} */ action: "auto_merge_disabled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; number: number; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -44049,7 +44081,7 @@ export interface components { "webhook-pull-request-auto-merge-enabled": { /** @enum {string} */ action: "auto_merge_enabled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; number: number; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -45238,7 +45270,7 @@ export interface components { "webhook-pull-request-closed": { /** @enum {string} */ action: "closed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -45299,7 +45331,7 @@ export interface components { "webhook-pull-request-converted-to-draft": { /** @enum {string} */ action: "converted_to_draft"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -45360,7 +45392,7 @@ export interface components { "webhook-pull-request-demilestoned": { /** @enum {string} */ action: "demilestoned"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; milestone?: components["schemas"]["milestone"]; /** @description The pull request number. */ number: number; @@ -46549,7 +46581,7 @@ export interface components { "webhook-pull-request-dequeued": { /** @enum {string} */ action: "dequeued"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; number: number; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -47757,7 +47789,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -47818,7 +47850,7 @@ export interface components { "webhook-pull-request-enqueued": { /** @enum {string} */ action: "enqueued"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; number: number; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -49006,7 +49038,7 @@ export interface components { "webhook-pull-request-labeled": { /** @enum {string} */ action: "labeled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** Label */ label?: { @@ -50211,7 +50243,7 @@ export interface components { "webhook-pull-request-locked": { /** @enum {string} */ action: "locked"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -51400,7 +51432,7 @@ export interface components { "webhook-pull-request-milestoned": { /** @enum {string} */ action: "milestoned"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; milestone?: components["schemas"]["milestone"]; /** @description The pull request number. */ number: number; @@ -52589,7 +52621,7 @@ export interface components { "webhook-pull-request-opened": { /** @enum {string} */ action: "opened"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -52650,7 +52682,7 @@ export interface components { "webhook-pull-request-ready-for-review": { /** @enum {string} */ action: "ready_for_review"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -52711,7 +52743,7 @@ export interface components { "webhook-pull-request-reopened": { /** @enum {string} */ action: "reopened"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -52917,7 +52949,7 @@ export interface components { url?: string; }) | null; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: { @@ -54189,7 +54221,7 @@ export interface components { url?: string; }) | null; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: { @@ -55468,7 +55500,7 @@ export interface components { url?: string; }) | null; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: { @@ -56595,7 +56627,7 @@ export interface components { "webhook-pull-request-review-dismissed": { /** @enum {string} */ action: "dismissed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ @@ -57802,7 +57834,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ @@ -58910,7 +58942,7 @@ export interface components { "webhook-pull-request-review-request-removed": OneOf<[{ /** @enum {string} */ action: "review_request_removed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -60127,7 +60159,7 @@ export interface components { }, { /** @enum {string} */ action: "review_request_removed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -61371,7 +61403,7 @@ export interface components { "webhook-pull-request-review-requested": OneOf<[{ /** @enum {string} */ action: "review_requested"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -62595,7 +62627,7 @@ export interface components { }, { /** @enum {string} */ action: "review_requested"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -63839,7 +63871,7 @@ export interface components { "webhook-pull-request-review-submitted": { /** @enum {string} */ action: "submitted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ @@ -65039,7 +65071,7 @@ export interface components { "webhook-pull-request-review-thread-resolved": { /** @enum {string} */ action: "resolved"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ @@ -66233,7 +66265,7 @@ export interface components { "webhook-pull-request-review-thread-unresolved": { /** @enum {string} */ action: "unresolved"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ @@ -67429,7 +67461,7 @@ export interface components { action: "synchronize"; after: string; before: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -68648,7 +68680,7 @@ export interface components { /** Format: uri */ url?: string; }) | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -69837,7 +69869,7 @@ export interface components { "webhook-pull-request-unlabeled": { /** @enum {string} */ action: "unlabeled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** Label */ label?: { @@ -71035,7 +71067,7 @@ export interface components { "webhook-pull-request-unlocked": { /** @enum {string} */ action: "unlocked"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -72284,7 +72316,7 @@ export interface components { created: boolean; /** @description Whether this push deleted the `ref`. */ deleted: boolean; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description Whether this push was a force push of the `ref`. */ forced: boolean; /** Commit */ @@ -72602,7 +72634,7 @@ export interface components { "webhook-registry-package-published": { /** @enum {string} */ action: "published"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; registry_package: { @@ -72798,7 +72830,7 @@ export interface components { "webhook-registry-package-updated": { /** @enum {string} */ action: "updated"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; registry_package: { @@ -72932,7 +72964,7 @@ export interface components { "webhook-release-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @@ -73089,7 +73121,7 @@ export interface components { "webhook-release-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @@ -73260,7 +73292,7 @@ export interface components { to: boolean; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @@ -73417,7 +73449,7 @@ export interface components { "webhook-release-prereleased": { /** @enum {string} */ action: "prereleased"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; release: ({ @@ -73612,7 +73644,7 @@ export interface components { "webhook-release-published": { /** @enum {string} */ action: "published"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; release: ({ @@ -73804,7 +73836,7 @@ export interface components { "webhook-release-released": { /** @enum {string} */ action: "released"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @@ -73961,7 +73993,7 @@ export interface components { "webhook-release-unpublished": { /** @enum {string} */ action: "unpublished"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; release: ({ @@ -74152,7 +74184,7 @@ export interface components { "webhook-repository-advisory-published": { /** @enum {string} */ action: "published"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74163,7 +74195,7 @@ export interface components { "webhook-repository-advisory-reported": { /** @enum {string} */ action: "reported"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74174,7 +74206,7 @@ export interface components { "webhook-repository-archived": { /** @enum {string} */ action: "archived"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74184,7 +74216,7 @@ export interface components { "webhook-repository-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74194,7 +74226,7 @@ export interface components { "webhook-repository-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74208,7 +74240,7 @@ export interface components { client_payload: { [key: string]: unknown; } | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74232,7 +74264,7 @@ export interface components { from?: string[] | null; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74240,7 +74272,7 @@ export interface components { }; /** repository_import event */ "webhook-repository-import": { - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74252,7 +74284,7 @@ export interface components { "webhook-repository-privatized": { /** @enum {string} */ action: "privatized"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74262,7 +74294,7 @@ export interface components { "webhook-repository-publicized": { /** @enum {string} */ action: "publicized"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74279,7 +74311,7 @@ export interface components { }; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74289,7 +74321,7 @@ export interface components { "webhook-repository-ruleset-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -74300,7 +74332,7 @@ export interface components { "webhook-repository-ruleset-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -74311,7 +74343,7 @@ export interface components { "webhook-repository-ruleset-edited": { /** @enum {string} */ action: "edited"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -74437,7 +74469,7 @@ export interface components { }; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74447,7 +74479,7 @@ export interface components { "webhook-repository-unarchived": { /** @enum {string} */ action: "unarchived"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74529,7 +74561,7 @@ export interface components { /** @enum {string} */ state: "open"; }); - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74652,7 +74684,7 @@ export interface components { /** @enum {string} */ state: "dismissed"; }); - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74734,7 +74766,7 @@ export interface components { /** @enum {string} */ state: "open"; }); - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74819,7 +74851,7 @@ export interface components { /** @enum {string} */ state: "fixed" | "open"; }); - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74830,7 +74862,7 @@ export interface components { /** @enum {string} */ action: "created"; alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74857,7 +74889,7 @@ export interface components { /** @enum {string} */ action: "reopened"; alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74868,7 +74900,7 @@ export interface components { /** @enum {string} */ action: "resolved"; alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74879,7 +74911,7 @@ export interface components { /** @enum {string} */ action: "revoked"; alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -74889,7 +74921,7 @@ export interface components { "webhook-security-advisory-published": { /** @enum {string} */ action: "published"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -74936,7 +74968,7 @@ export interface components { "webhook-security-advisory-updated": { /** @enum {string} */ action: "updated"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -74983,7 +75015,7 @@ export interface components { "webhook-security-advisory-withdrawn": { /** @enum {string} */ action: "withdrawn"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -75033,7 +75065,7 @@ export interface components { security_and_analysis?: components["schemas"]["security-and-analysis"]; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["full-repository"]; @@ -75043,7 +75075,7 @@ export interface components { "webhook-sponsorship-cancelled": { /** @enum {string} */ action: "cancelled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -75167,7 +75199,7 @@ export interface components { "webhook-sponsorship-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -75297,7 +75329,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -75423,7 +75455,7 @@ export interface components { action: "pending_cancellation"; /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ effective_date?: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -75568,7 +75600,7 @@ export interface components { }; /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ effective_date?: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -75711,7 +75743,7 @@ export interface components { }; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -75835,7 +75867,7 @@ export interface components { "webhook-star-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -75847,7 +75879,7 @@ export interface components { "webhook-star-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -76008,7 +76040,7 @@ export interface components { created_at: string; /** @description The optional human-readable description added to the status. */ description: string | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The unique identifier of the status. */ id: number; installation?: components["schemas"]["simple-installation"]; @@ -76029,7 +76061,7 @@ export interface components { }; /** team_add event */ "webhook-team-add": { - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -76104,7 +76136,7 @@ export interface components { "webhook-team-added-to-repository": { /** @enum {string} */ action: "added_to_repository"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; /** @@ -76413,7 +76445,7 @@ export interface components { "webhook-team-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; /** @@ -76722,7 +76754,7 @@ export interface components { "webhook-team-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; /** @@ -77062,7 +77094,7 @@ export interface components { }; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; /** @@ -77371,7 +77403,7 @@ export interface components { "webhook-team-removed-from-repository": { /** @enum {string} */ action: "removed_from_repository"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; /** @@ -77680,7 +77712,7 @@ export interface components { "webhook-watch-started": { /** @enum {string} */ action: "started"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77688,7 +77720,7 @@ export interface components { }; /** workflow_dispatch event */ "webhook-workflow-dispatch": { - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; inputs: { [key: string]: unknown; } | null; @@ -77703,7 +77735,7 @@ export interface components { "webhook-workflow-job-completed": { /** @enum {string} */ action: "completed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77793,7 +77825,7 @@ export interface components { "webhook-workflow-job-in-progress": { /** @enum {string} */ action: "in_progress"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77891,7 +77923,7 @@ export interface components { "webhook-workflow-job-queued": { /** @enum {string} */ action: "queued"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77945,7 +77977,7 @@ export interface components { "webhook-workflow-job-waiting": { /** @enum {string} */ action: "waiting"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77999,7 +78031,7 @@ export interface components { "webhook-workflow-run-completed": { /** @enum {string} */ action: "completed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -78686,7 +78718,7 @@ export interface components { "webhook-workflow-run-in-progress": { /** @enum {string} */ action: "in_progress"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -79373,7 +79405,7 @@ export interface components { "webhook-workflow-run-requested": { /** @enum {string} */ action: "requested"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -80365,7 +80397,7 @@ export interface operations { * 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)." */ "security-advisories/list-global-advisories": { - parameters: { + parameters?: { query?: { /** @description If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned. */ ghsa_id?: string; @@ -80547,7 +80579,7 @@ export interface operations { * 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. */ "apps/list-webhook-deliveries": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; @@ -80611,7 +80643,7 @@ export interface operations { * @description Lists all the pending installation requests for the authenticated GitHub App. */ "apps/list-installation-requests-for-authenticated-app": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -80635,7 +80667,7 @@ export interface operations { * The permissions the installation has are included under the `permissions` key. */ "apps/list-installations": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -81014,7 +81046,7 @@ export interface operations { * @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. */ "classroom/list-classrooms": { - parameters: { + parameters?: { query?: { page?: components["parameters"]["page"]; per_page?: components["parameters"]["per-page"]; @@ -81205,7 +81237,7 @@ export interface operations { * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ "activity/list-public-events": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -81252,7 +81284,7 @@ export interface operations { * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ "gists/list": { - parameters: { + parameters?: { query?: { since?: components["parameters"]["since"]; per_page?: components["parameters"]["per-page"]; @@ -81320,7 +81352,7 @@ export interface operations { * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), 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. */ "gists/list-public": { - parameters: { + parameters?: { query?: { since?: components["parameters"]["since"]; per_page?: components["parameters"]["per-page"]; @@ -81347,7 +81379,7 @@ export interface operations { * @description List the authenticated user's starred gists: */ "gists/list-starred": { - parameters: { + parameters?: { query?: { since?: components["parameters"]["since"]; per_page?: components["parameters"]["per-page"]; @@ -81770,7 +81802,7 @@ export interface operations { * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ "apps/list-repos-accessible-to-installation": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -81824,7 +81856,7 @@ export interface operations { * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. */ "issues/list": { - parameters: { + parameters?: { query?: { /** @description 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. */ filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; @@ -81863,7 +81895,7 @@ export interface operations { * @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)." */ "licenses/get-all-commonly-used": { - parameters: { + parameters?: { query?: { featured?: boolean; per_page?: components["parameters"]["per-page"]; @@ -81995,7 +82027,7 @@ export interface operations { * 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/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-plans": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -82082,7 +82114,7 @@ export interface operations { * 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/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-plans-stubbed": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -82184,7 +82216,7 @@ export interface operations { * @description List all notifications for the current user, sorted by most recently updated. */ "activity/list-notifications-for-authenticated-user": { - parameters: { + parameters?: { query?: { all?: components["parameters"]["all"]; participating?: components["parameters"]["participating"]; @@ -82374,7 +82406,7 @@ export interface operations { * @description Get the octocat as ASCII art */ "meta/get-octocat": { - parameters: { + parameters?: { query?: { /** @description The words to show in Octocat's speech bubble */ s?: string; @@ -82396,7 +82428,7 @@ export interface operations { * **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. */ "orgs/list": { - parameters: { + parameters?: { query?: { since?: components["parameters"]["since-org"]; per_page?: components["parameters"]["per-page"]; @@ -84451,6 +84483,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + Link: components["headers"]["link"]; + }; content: { "application/json": { /** @description Total number of Copilot For Business seats for the organization currently being billed. */ @@ -103038,7 +103073,7 @@ export interface operations { * - 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. */ "repos/list-public": { - parameters: { + parameters?: { query?: { since?: components["parameters"]["since-repo"]; }; @@ -104804,7 +104839,7 @@ export interface operations { * @description List the users you've blocked on your personal account. */ "users/list-blocked-by-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -104901,7 +104936,7 @@ export interface operations { * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. */ "codespaces/list-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -105021,7 +105056,7 @@ export interface operations { * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. */ "codespaces/list-secrets-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -105591,7 +105626,7 @@ export interface operations { * @description Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */ "users/list-emails-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -105670,7 +105705,7 @@ export interface operations { * @description Lists the people following the authenticated user. */ "users/list-followers-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -105696,7 +105731,7 @@ export interface operations { * @description Lists the people who the authenticated user follows. */ "users/list-followed-by-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -105789,7 +105824,7 @@ export interface operations { * @description Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ "users/list-gpg-keys-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -105896,7 +105931,7 @@ export interface operations { * You can find the permissions for the installation under the `permissions` key. */ "apps/list-installations-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -106069,7 +106104,7 @@ export interface operations { * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. */ "issues/list-for-authenticated-user": { - parameters: { + parameters?: { query?: { /** @description 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. */ filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; @@ -106103,7 +106138,7 @@ export interface operations { * @description Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ "users/list-public-ssh-keys-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -106203,7 +106238,7 @@ export interface operations { * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). */ "apps/list-subscriptions-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -106229,7 +106264,7 @@ export interface operations { * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). */ "apps/list-subscriptions-for-authenticated-user-stubbed": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -106254,7 +106289,7 @@ export interface operations { * @description Lists all of the authenticated user's organization memberships. */ "orgs/list-memberships-for-authenticated-user": { - parameters: { + parameters?: { query?: { /** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; @@ -106337,7 +106372,7 @@ export interface operations { * @description Lists all migrations a user has started. */ "migrations/list-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -106554,7 +106589,7 @@ export interface operations { * This 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. OAuth requests with insufficient scope receive a `403 Forbidden` response. */ "orgs/list-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -106818,7 +106853,7 @@ export interface operations { * @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. This endpoint is accessible with the `user:email` scope. */ "users/list-public-emails-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -106847,7 +106882,7 @@ export interface operations { * 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. */ "repos/list-for-authenticated-user": { - parameters: { + parameters?: { query?: { /** @description Limit results to repositories with the specified visibility. */ visibility?: "all" | "public" | "private"; @@ -107036,7 +107071,7 @@ export interface operations { * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ "repos/list-invitations-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -107099,7 +107134,7 @@ export interface operations { * @description Lists all of your social accounts. */ "users/list-social-accounts-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -107178,7 +107213,7 @@ export interface operations { * @description Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." */ "users/list-ssh-signing-keys-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -107280,7 +107315,7 @@ export interface operations { * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. */ "activity/list-repos-starred-by-authenticated-user": { - parameters: { + parameters?: { query?: { sort?: components["parameters"]["sort-starred"]; direction?: components["parameters"]["direction"]; @@ -107380,7 +107415,7 @@ export interface operations { * @description Lists repositories the authenticated user is watching. */ "activity/list-watched-repos-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -107406,7 +107441,7 @@ export interface operations { * @description List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token. */ "teams/list-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -107434,7 +107469,7 @@ export interface operations { * 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. */ "users/list": { - parameters: { + parameters?: { query?: { since?: components["parameters"]["since-user"]; per_page?: components["parameters"]["per-page"]; @@ -108344,7 +108379,7 @@ export interface operations { * @description All branch protections were disabled for a repository. */ "branch-protection-configuration/disabled": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108383,7 +108418,7 @@ export interface operations { * @description All branch protections were enabled for a repository. */ "branch-protection-configuration/enabled": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108420,7 +108455,7 @@ export interface operations { * @description A branch protection rule was created. */ "branch-protection-rule/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108457,7 +108492,7 @@ export interface operations { * @description A branch protection rule was deleted. */ "branch-protection-rule/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108494,7 +108529,7 @@ export interface operations { * @description A branch protection rule was edited. */ "branch-protection-rule/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108537,7 +108572,7 @@ export interface operations { * @description A check run was completed, and a conclusion is available. */ "check-run/completed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108581,7 +108616,7 @@ export interface operations { * @description A new check run was created. */ "check-run/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108625,7 +108660,7 @@ export interface operations { * @description A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see "[Creating CI tests with the Checks API](https://docs.github.com/developers/apps/guides/creating-ci-tests-with-the-checks-api)." */ "check-run/requested-action": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108669,7 +108704,7 @@ export interface operations { * @description Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload. */ "check-run/rerequested": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108713,7 +108748,7 @@ export interface operations { * @description All check runs in a check suite have completed, and a conclusion is available. */ "check-suite/completed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108756,7 +108791,7 @@ export interface operations { * @description Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/graphql/reference/mutations#createcheckrun) or "[Create a check run](https://docs.github.com/rest/checks/runs#create-a-check-run)" in the REST API documentation. */ "check-suite/requested": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108799,7 +108834,7 @@ export interface operations { * @description Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/graphql/reference/mutations#createchecksuite) or "[Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite)" in the REST API documentation. */ "check-suite/rerequested": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108836,7 +108871,7 @@ export interface operations { * @description A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert. */ "code-scanning-alert/appeared-in-branch": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108873,7 +108908,7 @@ export interface operations { * @description Someone closed a code scanning alert. */ "code-scanning-alert/closed-by-user": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108910,7 +108945,7 @@ export interface operations { * @description A code scanning alert was created in a repository. */ "code-scanning-alert/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108947,7 +108982,7 @@ export interface operations { * @description A code scanning alert was fixed in a branch by a commit. */ "code-scanning-alert/fixed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -108984,7 +109019,7 @@ export interface operations { * @description A previously fixed code scanning alert reappeared in a branch. */ "code-scanning-alert/reopened": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109021,7 +109056,7 @@ export interface operations { * @description Someone reopened a code scanning alert. */ "code-scanning-alert/reopened-by-user": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109060,7 +109095,7 @@ export interface operations { * @description Someone commented on a commit. */ "commit-comment/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109095,10 +109130,12 @@ export interface operations { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * - * **Note**: This event will not occur when more than three tags are created at once. + * **Notes**: + * - This event will not occur when more than three tags are created at once. + * - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. */ create: { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109137,7 +109174,7 @@ export interface operations { * **Note**: This event will not occur when more than three tags are deleted at once. */ delete: { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109178,7 +109215,7 @@ export interface operations { * @description A Dependabot alert was automatically closed. */ "dependabot-alert/auto-dismissed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109219,7 +109256,7 @@ export interface operations { * @description A Dependabot alert was automatically reopened. */ "dependabot-alert/auto-reopened": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109260,7 +109297,7 @@ export interface operations { * @description A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable. */ "dependabot-alert/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109301,7 +109338,7 @@ export interface operations { * @description A Dependabot alert was manually closed. */ "dependabot-alert/dismissed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109342,7 +109379,7 @@ export interface operations { * @description A manifest file change removed a vulnerability. */ "dependabot-alert/fixed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109383,7 +109420,7 @@ export interface operations { * @description A manifest file change introduced a vulnerable dependency that had previously been fixed. */ "dependabot-alert/reintroduced": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109424,7 +109461,7 @@ export interface operations { * @description A Dependabot alert was manually reopened. */ "dependabot-alert/reopened": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109461,7 +109498,7 @@ export interface operations { * @description A deploy key was created. */ "deploy-key/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109498,7 +109535,7 @@ export interface operations { * @description A deploy key was deleted. */ "deploy-key/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109537,7 +109574,7 @@ export interface operations { * @description A deployment was created. */ "deployment/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109574,7 +109611,7 @@ export interface operations { * @description A deployment protection rule was requested for an environment. */ "deployment-protection-rule/requested": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109613,7 +109650,7 @@ export interface operations { * @description A deployment review was approved. */ "deployment-review/approved": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109652,7 +109689,7 @@ export interface operations { * @description A deployment review was rejected. */ "deployment-review/rejected": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109691,7 +109728,7 @@ export interface operations { * @description A deployment review was requested. */ "deployment-review/requested": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109730,7 +109767,7 @@ export interface operations { * @description A new deployment status was created. */ "deployment-status/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109771,7 +109808,7 @@ export interface operations { * @description A comment on the discussion was marked as the answer. */ "discussion/answered": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109812,7 +109849,7 @@ export interface operations { * @description The category of a discussion was changed. */ "discussion/category-changed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109853,7 +109890,7 @@ export interface operations { * @description A discussion was closed. */ "discussion/closed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109894,7 +109931,7 @@ export interface operations { * @description A comment on a discussion was created. */ "discussion-comment/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109935,7 +109972,7 @@ export interface operations { * @description A comment on a discussion was deleted. */ "discussion-comment/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -109976,7 +110013,7 @@ export interface operations { * @description A comment on a discussion was edited. */ "discussion-comment/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110017,7 +110054,7 @@ export interface operations { * @description A discussion was created. */ "discussion/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110058,7 +110095,7 @@ export interface operations { * @description A discussion was deleted. */ "discussion/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110099,7 +110136,7 @@ export interface operations { * @description The title or body on a discussion was edited, or the category of the discussion was changed. */ "discussion/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110140,7 +110177,7 @@ export interface operations { * @description A label was added to a discussion. */ "discussion/labeled": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110181,7 +110218,7 @@ export interface operations { * @description A discussion was locked. */ "discussion/locked": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110222,7 +110259,7 @@ export interface operations { * @description A discussion was pinned. */ "discussion/pinned": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110263,7 +110300,7 @@ export interface operations { * @description A discussion was reopened. */ "discussion/reopened": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110304,7 +110341,7 @@ export interface operations { * @description A discussion was transferred to another repository. */ "discussion/transferred": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110345,7 +110382,7 @@ export interface operations { * @description A comment on the discussion was unmarked as the answer. */ "discussion/unanswered": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110386,7 +110423,7 @@ export interface operations { * @description A label was removed from a discussion. */ "discussion/unlabeled": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110427,7 +110464,7 @@ export interface operations { * @description A discussion was unlocked. */ "discussion/unlocked": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110468,7 +110505,7 @@ export interface operations { * @description A discussion was unpinned. */ "discussion/unpinned": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110504,7 +110541,7 @@ export interface operations { * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. */ fork: { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110543,7 +110580,7 @@ export interface operations { * @description Someone revoked their authorization of a GitHub App. */ "github-app-authorization/revoked": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110579,7 +110616,7 @@ export interface operations { * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. */ gollum: { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110616,7 +110653,7 @@ export interface operations { * @description Someone installed a GitHub App on a user or organization account. */ "installation/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110653,7 +110690,7 @@ export interface operations { * @description Someone uninstalled a GitHub App from their user or organization account. */ "installation/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110690,7 +110727,7 @@ export interface operations { * @description Someone granted new permissions to a GitHub App. */ "installation/new-permissions-accepted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110727,7 +110764,7 @@ export interface operations { * @description A GitHub App installation was granted access to one or more repositories. */ "installation-repositories/added": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110764,7 +110801,7 @@ export interface operations { * @description Access to one or more repositories was revoked for a GitHub App installation. */ "installation-repositories/removed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110801,7 +110838,7 @@ export interface operations { * @description Someone blocked access by a GitHub App to their user or organization account. */ "installation/suspend": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110836,7 +110873,7 @@ export interface operations { * @description Somebody renamed the user or organization account that a GitHub App is installed on. */ "installation-target/renamed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110873,7 +110910,7 @@ export interface operations { * @description A GitHub App that was blocked from accessing a user or organization account was given access the account again. */ "installation/unsuspend": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110912,7 +110949,7 @@ export interface operations { * @description A comment on an issue or pull request was created. */ "issue-comment/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110951,7 +110988,7 @@ export interface operations { * @description A comment on an issue or pull request was deleted. */ "issue-comment/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -110990,7 +111027,7 @@ export interface operations { * @description A comment on an issue or pull request was edited. */ "issue-comment/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111029,7 +111066,7 @@ export interface operations { * @description An issue was assigned to a user. */ "issues/assigned": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111068,7 +111105,7 @@ export interface operations { * @description An issue was closed. */ "issues/closed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111107,7 +111144,7 @@ export interface operations { * @description An issue was deleted. */ "issues/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111146,7 +111183,7 @@ export interface operations { * @description An issue was removed from a milestone. */ "issues/demilestoned": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111185,7 +111222,7 @@ export interface operations { * @description The title or body on an issue was edited. */ "issues/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111224,7 +111261,7 @@ export interface operations { * @description A label was added to an issue. */ "issues/labeled": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111263,7 +111300,7 @@ export interface operations { * @description Conversation on an issue was locked. For more information, see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." */ "issues/locked": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111302,7 +111339,7 @@ export interface operations { * @description An issue was added to a milestone. */ "issues/milestoned": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111341,7 +111378,7 @@ export interface operations { * @description An issue was created. When a closed issue is reopened, the action will be `reopened` instead. */ "issues/opened": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111380,7 +111417,7 @@ export interface operations { * @description An issue was pinned to a repository. For more information, see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." */ "issues/pinned": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111419,7 +111456,7 @@ export interface operations { * @description A closed issue was reopened. */ "issues/reopened": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111458,7 +111495,7 @@ export interface operations { * @description An issue was transferred to another repository. For more information, see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." */ "issues/transferred": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111497,7 +111534,7 @@ export interface operations { * @description A user was unassigned from an issue. */ "issues/unassigned": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111536,7 +111573,7 @@ export interface operations { * @description A label was removed from an issue. */ "issues/unlabeled": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111575,7 +111612,7 @@ export interface operations { * @description Conversation on an issue was locked. For more information, see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." */ "issues/unlocked": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111614,7 +111651,7 @@ export interface operations { * @description An issue was unpinned from a repository. For more information, see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." */ "issues/unpinned": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111653,7 +111690,7 @@ export interface operations { * @description A label was created. */ "label/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111692,7 +111729,7 @@ export interface operations { * @description A label was deleted. */ "label/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111731,7 +111768,7 @@ export interface operations { * @description A label's name, description, or color was changed. */ "label/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111766,7 +111803,7 @@ export interface operations { * @description Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately. */ "marketplace-purchase/cancelled": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111801,7 +111838,7 @@ export interface operations { * @description Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately. */ "marketplace-purchase/changed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111836,7 +111873,7 @@ export interface operations { * @description Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent. */ "marketplace-purchase/pending-change": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111871,7 +111908,7 @@ export interface operations { * @description Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle. */ "marketplace-purchase/pending-change-cancelled": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111906,7 +111943,7 @@ export interface operations { * @description Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately. */ "marketplace-purchase/purchased": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111943,7 +111980,7 @@ export interface operations { * @description A GitHub user accepted an invitation to a repository. */ "member/added": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -111980,7 +112017,7 @@ export interface operations { * @description Permissions were changed for a collaborator on a repository. */ "member/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112017,7 +112054,7 @@ export interface operations { * @description A collaborator was removed from a repository. */ "member/removed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112054,7 +112091,7 @@ export interface operations { * @description An organization member was added to a team. */ "membership/added": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112091,7 +112128,7 @@ export interface operations { * @description An organization member was removed from a team. */ "membership/removed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112130,7 +112167,7 @@ export interface operations { * When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses. */ "merge-group/checks-requested": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112169,7 +112206,7 @@ export interface operations { * When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used. */ "merge-group/destroyed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112206,7 +112243,7 @@ export interface operations { * @description The webhook was deleted. */ "meta/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112245,7 +112282,7 @@ export interface operations { * @description A milestone was closed. */ "milestone/closed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112284,7 +112321,7 @@ export interface operations { * @description A milestone was created. */ "milestone/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112323,7 +112360,7 @@ export interface operations { * @description A milestone was deleted. */ "milestone/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112362,7 +112399,7 @@ export interface operations { * @description A milestone was edited. */ "milestone/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112401,7 +112438,7 @@ export interface operations { * @description A milestone was opened. */ "milestone/opened": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112440,7 +112477,7 @@ export interface operations { * @description A user was blocked from the organization. */ "org-block/blocked": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112479,7 +112516,7 @@ export interface operations { * @description A previously blocked user was unblocked from the organization. */ "org-block/unblocked": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112518,7 +112555,7 @@ export interface operations { * @description An organization was deleted. */ "organization/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112557,7 +112594,7 @@ export interface operations { * @description A member accepted an invitation to join an organization. */ "organization/member-added": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112596,7 +112633,7 @@ export interface operations { * @description A member was invited to join the organization. */ "organization/member-invited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112635,7 +112672,7 @@ export interface operations { * @description A member was removed from the organization. */ "organization/member-removed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112674,7 +112711,7 @@ export interface operations { * @description The name of an organization was changed. */ "organization/renamed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112711,7 +112748,7 @@ export interface operations { * @description A package was published to a registry. */ "package/published": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112748,7 +112785,7 @@ export interface operations { * @description A previously published package was updated. */ "package/updated": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112784,7 +112821,7 @@ export interface operations { * To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission. */ "page-build": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112823,7 +112860,7 @@ export interface operations { * @description A fine-grained personal access token request was approved. */ "personal-access-token-request/approved": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112862,7 +112899,7 @@ export interface operations { * @description A fine-grained personal access token request was cancelled by the requester. */ "personal-access-token-request/cancelled": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112901,7 +112938,7 @@ export interface operations { * @description A fine-grained personal access token request was created. */ "personal-access-token-request/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112940,7 +112977,7 @@ export interface operations { * @description A fine-grained personal access token request was denied. */ "personal-access-token-request/denied": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -112972,7 +113009,7 @@ export interface operations { }; /** This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly. */ ping: { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113012,7 +113049,7 @@ export interface operations { * @description A note in a classic project was converted to an issue. */ "project-card/converted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113051,7 +113088,7 @@ export interface operations { * @description A card was added to a classic project. */ "project-card/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113090,7 +113127,7 @@ export interface operations { * @description A card on a classic project was deleted. */ "project-card/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113129,7 +113166,7 @@ export interface operations { * @description A note on a classic project was edited. */ "project-card/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113168,7 +113205,7 @@ export interface operations { * @description A card on a classic project was moved to another column or to another position in its column. */ "project-card/moved": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113207,7 +113244,7 @@ export interface operations { * @description A classic project was closed. */ "project/closed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113246,7 +113283,7 @@ export interface operations { * @description A column was added to a classic project. */ "project-column/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113285,7 +113322,7 @@ export interface operations { * @description A column was deleted from a classic project. */ "project-column/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113324,7 +113361,7 @@ export interface operations { * @description The name of a column on a classic project was changed. */ "project-column/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113363,7 +113400,7 @@ export interface operations { * @description A column was moved to a new position on a classic project. */ "project-column/moved": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113402,7 +113439,7 @@ export interface operations { * @description A classic project was created. */ "project/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113441,7 +113478,7 @@ export interface operations { * @description A classic project was deleted. */ "project/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113480,7 +113517,7 @@ export interface operations { * @description The name or description of a classic project was changed. */ "project/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113519,7 +113556,7 @@ export interface operations { * @description A classic project was closed. */ "project/reopened": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113560,7 +113597,7 @@ export interface operations { * @description A project in the organization was closed. */ "projects-v2/closed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113601,7 +113638,7 @@ export interface operations { * @description A project in the organization was created. */ "projects-v2/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113642,7 +113679,7 @@ export interface operations { * @description A project in the organization was deleted. */ "projects-v2/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113683,7 +113720,7 @@ export interface operations { * @description The title, description, or README of a project in the organization was changed. */ "projects-v2/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113724,7 +113761,7 @@ export interface operations { * @description An item on an organization project was archived. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." */ "projects-v2-item/archived": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113765,7 +113802,7 @@ export interface operations { * @description A draft issue in an organization project was converted to an issue. */ "projects-v2-item/converted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113806,7 +113843,7 @@ export interface operations { * @description An item was added to a project in the organization. */ "projects-v2-item/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113847,7 +113884,7 @@ export interface operations { * @description An item was deleted from a project in the organization. */ "projects-v2-item/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113888,7 +113925,7 @@ export interface operations { * @description The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue. */ "projects-v2-item/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113929,7 +113966,7 @@ export interface operations { * @description The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout. */ "projects-v2-item/reordered": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -113970,7 +114007,7 @@ export interface operations { * @description An archived item on an organization project was restored from the archive. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." */ "projects-v2-item/restored": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114011,7 +114048,7 @@ export interface operations { * @description A project in the organization was reopened. */ "projects-v2/reopened": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114047,7 +114084,7 @@ export interface operations { * To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. */ public: { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114086,7 +114123,7 @@ export interface operations { * @description A pull request was assigned to a user. */ "pull-request/assigned": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114125,7 +114162,7 @@ export interface operations { * @description Auto merge was disabled for a pull request. For more information, see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." */ "pull-request/auto-merge-disabled": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114164,7 +114201,7 @@ export interface operations { * @description Auto merge was enabled for a pull request. For more information, see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." */ "pull-request/auto-merge-enabled": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114203,7 +114240,7 @@ export interface operations { * @description A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged. */ "pull-request/closed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114242,7 +114279,7 @@ export interface operations { * @description A pull request was converted to a draft. For more information, see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." */ "pull-request/converted-to-draft": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114281,7 +114318,7 @@ export interface operations { * @description A pull request was removed from a milestone. */ "pull-request/demilestoned": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114320,7 +114357,7 @@ export interface operations { * @description A pull request was removed from the merge queue. */ "pull-request/dequeued": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114359,7 +114396,7 @@ export interface operations { * @description The title or body of a pull request was edited. */ "pull-request/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114398,7 +114435,7 @@ export interface operations { * @description A pull request was added to the merge queue. */ "pull-request/enqueued": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114437,7 +114474,7 @@ export interface operations { * @description A label was added to a pull request. */ "pull-request/labeled": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114476,7 +114513,7 @@ export interface operations { * @description Conversation on a pull request was locked. For more information, see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." */ "pull-request/locked": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114515,7 +114552,7 @@ export interface operations { * @description A pull request was added to a milestone. */ "pull-request/milestoned": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114554,7 +114591,7 @@ export interface operations { * @description A pull request was created */ "pull-request/opened": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114593,7 +114630,7 @@ export interface operations { * @description A draft pull request was marked as ready for review. For more information, see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." */ "pull-request/ready-for-review": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114632,7 +114669,7 @@ export interface operations { * @description A previously closed pull request was reopened. */ "pull-request/reopened": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114671,7 +114708,7 @@ export interface operations { * @description A comment on a pull request diff was created. */ "pull-request-review-comment/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114710,7 +114747,7 @@ export interface operations { * @description A comment on a pull request diff was deleted. */ "pull-request-review-comment/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114749,7 +114786,7 @@ export interface operations { * @description The content of a comment on a pull request diff was changed. */ "pull-request-review-comment/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114788,7 +114825,7 @@ export interface operations { * @description A review on a pull request was dismissed. */ "pull-request-review/dismissed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114827,7 +114864,7 @@ export interface operations { * @description The body comment on a pull request review was edited. */ "pull-request-review/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114866,7 +114903,7 @@ export interface operations { * @description A request for review by a person or team was removed from a pull request. */ "pull-request/review-request-removed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114905,7 +114942,7 @@ export interface operations { * @description Review by a person or team was requested for a pull request. For more information, see "[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." */ "pull-request/review-requested": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114944,7 +114981,7 @@ export interface operations { * @description A review on a pull request was submitted. */ "pull-request-review/submitted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -114983,7 +115020,7 @@ export interface operations { * @description A comment thread on a pull request was marked as resolved. */ "pull-request-review-thread/resolved": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115022,7 +115059,7 @@ export interface operations { * @description A previously resolved comment thread on a pull request was marked as unresolved. */ "pull-request-review-thread/unresolved": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115061,7 +115098,7 @@ export interface operations { * @description A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch. */ "pull-request/synchronize": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115100,7 +115137,7 @@ export interface operations { * @description A user was unassigned from a pull request. */ "pull-request/unassigned": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115139,7 +115176,7 @@ export interface operations { * @description A label was removed from a pull request. */ "pull-request/unlabeled": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115178,7 +115215,7 @@ export interface operations { * @description Conversation on a pull request was unlocked. For more information, see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." */ "pull-request/unlocked": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115210,7 +115247,7 @@ export interface operations { }; /** * This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, - * when a branch is deleted, when a tag is deleted, or when a repository is cloned. To subscribe to only branch + * when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch * and tag deletions, use the [`delete`](#delete) webhook event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. @@ -115218,7 +115255,7 @@ export interface operations { * **Note**: An event will not be created when more than three tags are pushed at once. */ push: { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115257,7 +115294,7 @@ export interface operations { * @description A package was published to a registry. */ "registry-package/published": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115296,7 +115333,7 @@ export interface operations { * @description A package that was previously published to a registry was updated. */ "registry-package/updated": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115333,7 +115370,7 @@ export interface operations { * @description A draft was saved, or a release or pre-release was published without previously being saved as a draft. */ "release/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115370,7 +115407,7 @@ export interface operations { * @description A release, pre-release, or draft release was deleted. */ "release/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115407,7 +115444,7 @@ export interface operations { * @description The details of a release, pre-release, or draft release were edited. For more information, see "[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." */ "release/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115444,7 +115481,7 @@ export interface operations { * @description A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable. */ "release/prereleased": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115481,7 +115518,7 @@ export interface operations { * @description A release, pre-release, or draft of a release was published. */ "release/published": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115518,7 +115555,7 @@ export interface operations { * @description A release was published, or a pre-release was changed to a release. */ "release/released": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115555,7 +115592,7 @@ export interface operations { * @description A release or pre-release was unpublished. */ "release/unpublished": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115592,7 +115629,7 @@ export interface operations { * @description A repository security advisory was published. */ "repository-advisory/published": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115629,7 +115666,7 @@ export interface operations { * @description A private vulnerability report was submitted. */ "repository-advisory/reported": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115666,7 +115703,7 @@ export interface operations { * @description A repository was archived. */ "repository/archived": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115703,7 +115740,7 @@ export interface operations { * @description A repository was created. */ "repository/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115740,7 +115777,7 @@ export interface operations { * @description A repository was deleted. GitHub Apps and repository webhooks will not receive this event. */ "repository/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115777,7 +115814,7 @@ export interface operations { * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ "repository-dispatch/sample.collected": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115814,7 +115851,7 @@ export interface operations { * @description The topics, default branch, description, or homepage of a repository was changed. */ "repository/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115846,7 +115883,7 @@ export interface operations { }; /** This event occurs when a repository is imported to GitHub. For more information, see "[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports). */ "repository-import": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115883,7 +115920,7 @@ export interface operations { * @description The visibility of a repository was changed to `private`. */ "repository/privatized": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115920,7 +115957,7 @@ export interface operations { * @description The visibility of a repository was changed to `public`. */ "repository/publicized": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115957,7 +115994,7 @@ export interface operations { * @description The name of a repository was changed. */ "repository/renamed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -115996,7 +116033,7 @@ export interface operations { * @description A repository ruleset was created. */ "repository-ruleset/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116035,7 +116072,7 @@ export interface operations { * @description A repository ruleset was deleted. */ "repository-ruleset/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116074,7 +116111,7 @@ export interface operations { * @description A repository ruleset was edited. */ "repository-ruleset/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116111,7 +116148,7 @@ export interface operations { * @description Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to "Repository" events. */ "repository/transferred": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116148,7 +116185,7 @@ export interface operations { * @description A previously archived repository was unarchived. */ "repository/unarchived": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116185,7 +116222,7 @@ export interface operations { * @description A repository vulnerability alert was created. */ "repository-vulnerability-alert/create": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116222,7 +116259,7 @@ export interface operations { * @description A repository vulnerability alert was dismissed. */ "repository-vulnerability-alert/dismiss": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116259,7 +116296,7 @@ export interface operations { * @description A previously dismissed or resolved repository vulnerability alert was reopened. */ "repository-vulnerability-alert/reopen": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116296,7 +116333,7 @@ export interface operations { * @description A repository vulnerability alert was marked as resolved. */ "repository-vulnerability-alert/resolve": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116335,7 +116372,7 @@ export interface operations { * @description A secret scanning alert was created. */ "secret-scanning-alert/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116376,7 +116413,7 @@ export interface operations { * @description A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert. */ "secret-scanning-alert-location/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116416,7 +116453,7 @@ export interface operations { * @description A previously closed secret scanning alert was reopened. */ "secret-scanning-alert/reopened": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116455,7 +116492,7 @@ export interface operations { * @description A secret scanning alert was closed. */ "secret-scanning-alert/resolved": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116494,7 +116531,7 @@ export interface operations { * @description A secret scanning alert was marked as revoked. */ "secret-scanning-alert/revoked": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116531,7 +116568,7 @@ export interface operations { * @description A security advisory was published to the GitHub community. */ "security-advisory/published": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116568,7 +116605,7 @@ export interface operations { * @description The metadata or description of a security advisory was changed, or the security advisory was withdrawn. */ "security-advisory/updated": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116605,7 +116642,7 @@ export interface operations { * @description A previously published security advisory was withdrawn. */ "security-advisory/withdrawn": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116641,7 +116678,7 @@ export interface operations { * To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. */ "security-and-analysis": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116680,7 +116717,7 @@ export interface operations { * This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. */ "sponsorship/cancelled": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116717,7 +116754,7 @@ export interface operations { * @description A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed. */ "sponsorship/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116754,7 +116791,7 @@ export interface operations { * @description A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs. */ "sponsorship/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116793,7 +116830,7 @@ export interface operations { * This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. */ "sponsorship/pending-cancellation": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116830,7 +116867,7 @@ export interface operations { * @description A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date. */ "sponsorship/pending-tier-change": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116867,7 +116904,7 @@ export interface operations { * @description A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle. */ "sponsorship/tier-changed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116904,7 +116941,7 @@ export interface operations { * @description Someone starred a repository. */ "star/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116941,7 +116978,7 @@ export interface operations { * @description Someone unstarred the repository. */ "star/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -116977,7 +117014,7 @@ export interface operations { * To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. */ status: { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -117016,7 +117053,7 @@ export interface operations { * To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. */ "team-add": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -117054,7 +117091,7 @@ export interface operations { * @description A team was granted access to a repository. */ "team/added-to-repository": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -117092,7 +117129,7 @@ export interface operations { * @description A team was created. */ "team/created": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -117130,7 +117167,7 @@ export interface operations { * @description A team was deleted. */ "team/deleted": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -117168,7 +117205,7 @@ export interface operations { * @description The name, description, or visibility of a team was changed. */ "team/edited": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -117206,7 +117243,7 @@ export interface operations { * @description A team's access to a repository was removed. */ "team/removed-from-repository": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -117243,7 +117280,7 @@ export interface operations { * @description Someone started watching the repository. */ "watch/started": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -117281,7 +117318,7 @@ export interface operations { * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. */ "workflow-dispatch": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -117320,7 +117357,7 @@ export interface operations { * @description A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful. */ "workflow-job/completed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -117359,7 +117396,7 @@ export interface operations { * @description A job in a workflow run started processing on a runner. */ "workflow-job/in-progress": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -117398,7 +117435,7 @@ export interface operations { * @description A job in a workflow run was created. */ "workflow-job/queued": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -117437,7 +117474,7 @@ export interface operations { * @description A job in a workflow run was created and is waiting for approvals. */ "workflow-job/waiting": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -117476,7 +117513,7 @@ export interface operations { * @description A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful. */ "workflow-run/completed": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -117515,7 +117552,7 @@ export interface operations { * @description A workflow run started processing on a runner. */ "workflow-run/in-progress": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; @@ -117554,7 +117591,7 @@ export interface operations { * @description A workflow run was triggered. */ "workflow-run/requested": { - parameters: { + parameters?: { header?: { /** @example GitHub-Hookshot/123abc */ "User-Agent"?: string; diff --git a/packages/openapi-typescript/examples/github-api-next.yaml b/packages/openapi-typescript/examples/github-api-next.yaml index 6c3c71ce3..0d1c05da1 100644 --- a/packages/openapi-typescript/examples/github-api-next.yaml +++ b/packages/openapi-typescript/examples/github-api-next.yaml @@ -6537,6 +6537,9 @@ paths: examples: default: "$ref": "#/components/examples/copilot-seats-list" + headers: + Link: + "$ref": "#/components/headers/link" '500': "$ref": "#/components/responses/internal_error" '401': @@ -45188,7 +45191,9 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - **Note**: This event will not occur when more than three tags are created at once. + **Notes**: + - This event will not occur when more than three tags are created at once. + - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. operationId: create externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#create @@ -55576,7 +55581,7 @@ webhooks: post: summary: |- This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, - when a branch is deleted, when a tag is deleted, or when a repository is cloned. To subscribe to only branch + when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch and tag deletions, use the [`delete`](#delete) webhook event. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. @@ -84299,6 +84304,75 @@ components: required: - key - id + enterprise-webhooks: + title: Enterprise + description: | + An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured + on an enterprise account or an organization that's part of an enterprise account. For more information, + see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." + type: object + properties: + description: + description: A short description of the enterprise. + type: + - string + - 'null' + html_url: + type: string + format: uri + examples: + - https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: + - string + - 'null' + format: uri + id: + description: Unique identifier of the enterprise + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + examples: + - Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + examples: + - octo-business + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2019-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url simple-installation: title: Simple Installation description: |- @@ -86219,7 +86293,7 @@ components: enum: - disabled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -86241,7 +86315,7 @@ components: enum: - enabled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -86263,7 +86337,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -86416,7 +86490,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -86640,7 +86714,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -87524,7 +87598,7 @@ components: - check_runs_url - head_commit enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -88136,7 +88210,7 @@ components: - check_runs_url - head_commit enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -88742,7 +88816,7 @@ components: - check_runs_url - head_commit enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -88995,7 +89069,7 @@ components: the `sender` and this value will be empty. type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -89276,7 +89350,7 @@ components: the `sender` and this value will be empty. type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -89500,7 +89574,7 @@ components: the `sender` and this value will be empty. type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -89785,7 +89859,7 @@ components: the `sender` and this value will be empty. type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -90002,7 +90076,7 @@ components: - string - 'null' enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -90189,7 +90263,7 @@ components: the `sender` and this value will be empty. type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -90395,7 +90469,7 @@ components: - author_association - body enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -90419,7 +90493,7 @@ components: - string - 'null' enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" master_branch: @@ -90458,7 +90532,7 @@ components: type: object properties: enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -90502,7 +90576,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -90527,7 +90601,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -90552,7 +90626,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -90577,7 +90651,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -90602,7 +90676,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -90627,7 +90701,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -90652,7 +90726,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -90671,7 +90745,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" key: @@ -90730,7 +90804,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" key: @@ -91277,7 +91351,7 @@ components: - statuses_url - repository_url enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -92020,7 +92094,7 @@ components: comment: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -92827,7 +92901,7 @@ components: comment: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -93593,7 +93667,7 @@ components: enum: - requested enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" environment: type: string installation: @@ -95459,7 +95533,7 @@ components: - deployment_url - repository_url enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -96289,7 +96363,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -96359,7 +96433,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -96385,7 +96459,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -96567,7 +96641,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -96750,7 +96824,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -96945,7 +97019,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97405,7 +97479,7 @@ components: - answer_chosen_at - answer_chosen_by enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97430,7 +97504,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97472,7 +97546,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97497,7 +97571,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: @@ -97556,7 +97630,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97581,7 +97655,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97606,7 +97680,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97641,7 +97715,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97845,7 +97919,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: @@ -97904,7 +97978,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97929,7 +98003,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97949,7 +98023,7 @@ components: type: object properties: enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -98645,7 +98719,7 @@ components: enum: - revoked enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -98662,7 +98736,7 @@ components: type: object properties: enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -98721,7 +98795,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: @@ -98837,7 +98911,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: @@ -98887,7 +98961,7 @@ components: enum: - new_permissions_accepted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: @@ -98937,7 +99011,7 @@ components: enum: - added enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: @@ -99084,7 +99158,7 @@ components: enum: - removed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: @@ -99237,7 +99311,7 @@ components: enum: - suspend enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: @@ -99387,7 +99461,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -99413,7 +99487,7 @@ components: enum: - unsuspend enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: @@ -99629,7 +99703,7 @@ components: - body - reactions enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -100981,7 +101055,7 @@ components: - body - reactions enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -102341,7 +102415,7 @@ components: - body - reactions enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -103596,7 +103670,7 @@ components: - login - id enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -104538,7 +104612,7 @@ components: enum: - closed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -105624,7 +105698,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -106559,7 +106633,7 @@ components: enum: - demilestoned enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -107936,7 +108010,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -108912,7 +108986,7 @@ components: enum: - labeled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -109886,7 +109960,7 @@ components: enum: - locked enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -110969,7 +111043,7 @@ components: enum: - milestoned enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -113702,7 +113776,7 @@ components: - old_issue - old_repository enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -114641,7 +114715,7 @@ components: enum: - pinned enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -115575,7 +115649,7 @@ components: enum: - reopened enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -118043,7 +118117,7 @@ components: - new_issue - new_repository enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -119049,7 +119123,7 @@ components: - login - id enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -119990,7 +120064,7 @@ components: enum: - unlabeled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -120964,7 +121038,7 @@ components: enum: - unlocked enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -122037,7 +122111,7 @@ components: enum: - unpinned enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -122971,7 +123045,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: @@ -123026,7 +123100,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: @@ -123113,7 +123187,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: @@ -123171,7 +123245,7 @@ components: effective_date: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: @@ -123430,7 +123504,7 @@ components: effective_date: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: @@ -123692,7 +123766,7 @@ components: effective_date: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: @@ -123952,7 +124026,7 @@ components: effective_date: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: @@ -124152,7 +124226,7 @@ components: effective_date: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: @@ -124423,7 +124497,7 @@ components: required: - to enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" member: @@ -124539,7 +124613,7 @@ components: - string - 'null' enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" member: @@ -124632,7 +124706,7 @@ components: enum: - removed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" member: @@ -124724,7 +124798,7 @@ components: enum: - added enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" member: @@ -125005,7 +125079,7 @@ components: enum: - removed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" member: @@ -125336,7 +125410,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, @@ -125467,7 +125541,7 @@ components: enum: - closed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" milestone: @@ -125631,7 +125705,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" milestone: @@ -125794,7 +125868,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" milestone: @@ -125989,7 +126063,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" milestone: @@ -126154,7 +126228,7 @@ components: enum: - opened enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" milestone: @@ -126386,7 +126460,7 @@ components: - login - id enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -126478,7 +126552,7 @@ components: - login - id enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -126501,7 +126575,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" membership: @@ -126614,7 +126688,7 @@ components: enum: - member_added enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" membership: @@ -126728,7 +126802,7 @@ components: enum: - member_invited enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" invitation: @@ -126938,7 +127012,7 @@ components: enum: - member_removed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" membership: @@ -127060,7 +127134,7 @@ components: from: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" membership: @@ -127206,7 +127280,7 @@ components: enum: - published enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -127810,7 +127884,7 @@ components: enum: - updated enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -128363,7 +128437,7 @@ components: - created_at - updated_at enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" id: type: integer installation: @@ -128584,7 +128658,7 @@ components: required: - note enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -128728,7 +128802,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -128871,7 +128945,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -129033,7 +129107,7 @@ components: required: - note enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -129189,7 +129263,7 @@ components: required: - column_id enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -129405,7 +129479,7 @@ components: enum: - closed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -129552,7 +129626,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -129613,7 +129687,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -129686,7 +129760,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -129748,7 +129822,7 @@ components: enum: - moved enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -129810,7 +129884,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -129957,7 +130031,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -130126,7 +130200,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -130272,7 +130346,7 @@ components: enum: - reopened enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -130797,7 +130871,7 @@ components: type: object properties: enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -130887,7 +130961,7 @@ components: - login - id enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -133221,7 +133295,7 @@ components: enum: - auto_merge_disabled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -135549,7 +135623,7 @@ components: enum: - auto_merge_enabled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -137877,7 +137951,7 @@ components: enum: - closed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -137967,7 +138041,7 @@ components: enum: - converted_to_draft enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -138057,7 +138131,7 @@ components: enum: - demilestoned enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" milestone: "$ref": "#/components/schemas/milestone" number: @@ -140374,7 +140448,7 @@ components: enum: - dequeued enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -142735,7 +142809,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -142825,7 +142899,7 @@ components: enum: - enqueued enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -145141,7 +145215,7 @@ components: enum: - labeled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: @@ -147508,7 +147582,7 @@ components: enum: - locked enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -149840,7 +149914,7 @@ components: enum: - milestoned enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" milestone: "$ref": "#/components/schemas/milestone" number: @@ -152157,7 +152231,7 @@ components: enum: - opened enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -152247,7 +152321,7 @@ components: enum: - ready_for_review enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -152337,7 +152411,7 @@ components: enum: - reopened enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -152716,7 +152790,7 @@ components: - side - reactions enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -155220,7 +155294,7 @@ components: - side - reactions enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -157724,7 +157798,7 @@ components: - side - reactions enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -159931,7 +160005,7 @@ components: enum: - dismissed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -162314,7 +162388,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -164567,7 +164641,7 @@ components: enum: - review_request_removed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -166960,7 +167034,7 @@ components: enum: - review_request_removed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -169407,7 +169481,7 @@ components: enum: - review_requested enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -171805,7 +171879,7 @@ components: enum: - review_requested enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -174228,7 +174302,7 @@ components: enum: - submitted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -176599,7 +176673,7 @@ components: enum: - resolved enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -179020,7 +179094,7 @@ components: enum: - unresolved enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -181425,7 +181499,7 @@ components: before: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -183817,7 +183891,7 @@ components: - login - id enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -186152,7 +186226,7 @@ components: enum: - unlabeled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: @@ -188509,7 +188583,7 @@ components: enum: - unlocked enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -190940,7 +191014,7 @@ components: description: Whether this push deleted the `ref`. type: boolean enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -191554,7 +191628,7 @@ components: enum: - published enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192102,7 +192176,7 @@ components: enum: - updated enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192480,7 +192554,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192817,7 +192891,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -193184,7 +193258,7 @@ components: required: - to enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -193521,7 +193595,7 @@ components: enum: - prereleased enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -193953,7 +194027,7 @@ components: enum: - published enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -194382,7 +194456,7 @@ components: enum: - released enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -194718,7 +194792,7 @@ components: enum: - unpublished enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195146,7 +195220,7 @@ components: enum: - published enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195170,7 +195244,7 @@ components: enum: - reported enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195194,7 +195268,7 @@ components: enum: - archived enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195216,7 +195290,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195238,7 +195312,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195267,7 +195341,7 @@ components: - 'null' additionalProperties: true enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195329,7 +195403,7 @@ components: items: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195348,7 +195422,7 @@ components: type: object properties: enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195376,7 +195450,7 @@ components: enum: - privatized enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195398,7 +195472,7 @@ components: enum: - publicized enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195437,7 +195511,7 @@ components: required: - repository enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195460,7 +195534,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195484,7 +195558,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195508,7 +195582,7 @@ components: enum: - edited enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195762,7 +195836,7 @@ components: required: - owner enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195785,7 +195859,7 @@ components: enum: - unarchived enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195966,7 +196040,7 @@ components: required: - state enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -196232,7 +196306,7 @@ components: - dismissed_at - state enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -196414,7 +196488,7 @@ components: required: - state enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -196602,7 +196676,7 @@ components: required: - state enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -196627,7 +196701,7 @@ components: alert: "$ref": "#/components/schemas/secret-scanning-alert-webhook" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -196686,7 +196760,7 @@ components: alert: "$ref": "#/components/schemas/secret-scanning-alert-webhook" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -196710,7 +196784,7 @@ components: alert: "$ref": "#/components/schemas/secret-scanning-alert-webhook" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -196734,7 +196808,7 @@ components: alert: "$ref": "#/components/schemas/secret-scanning-alert-webhook" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -196756,7 +196830,7 @@ components: enum: - published enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -196890,7 +196964,7 @@ components: enum: - updated enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -197024,7 +197098,7 @@ components: enum: - withdrawn enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -197160,7 +197234,7 @@ components: security_and_analysis: "$ref": "#/components/schemas/security-and-analysis" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -197181,7 +197255,7 @@ components: enum: - cancelled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -197429,7 +197503,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -197689,7 +197763,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -197943,7 +198017,7 @@ components: effect. type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -198239,7 +198313,7 @@ components: effect. type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -198531,7 +198605,7 @@ components: required: - tier enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -198780,7 +198854,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -198810,7 +198884,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -199184,7 +199258,7 @@ components: - string - 'null' enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" id: description: The unique identifier of the status. type: integer @@ -199235,7 +199309,7 @@ components: type: object properties: enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -199374,7 +199448,7 @@ components: enum: - added_to_repository enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -199970,7 +200044,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -200567,7 +200641,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -201228,7 +201302,7 @@ components: required: - permissions enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -201826,7 +201900,7 @@ components: enum: - removed_from_repository enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -202423,7 +202497,7 @@ components: enum: - started enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -202441,7 +202515,7 @@ components: type: object properties: enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" inputs: type: - object @@ -202474,7 +202548,7 @@ components: enum: - completed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -202749,7 +202823,7 @@ components: enum: - in_progress enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -203050,7 +203124,7 @@ components: enum: - queued enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -203219,7 +203293,7 @@ components: enum: - waiting enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -203389,7 +203463,7 @@ components: enum: - completed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -204845,7 +204919,7 @@ components: enum: - in_progress enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -206303,7 +206377,7 @@ components: enum: - requested enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: diff --git a/packages/openapi-typescript/examples/github-api.ts b/packages/openapi-typescript/examples/github-api.ts index d62e10554..bef9e453b 100644 --- a/packages/openapi-typescript/examples/github-api.ts +++ b/packages/openapi-typescript/examples/github-api.ts @@ -22950,6 +22950,55 @@ export interface components { id: number; key: string; }; + /** + * Enterprise + * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured + * on an enterprise account or an organization that's part of an enterprise account. For more information, + * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." + */ + "enterprise-webhooks": { + /** @description A short description of the enterprise. */ + description?: string | null; + /** + * Format: uri + * @example https://github.com/enterprises/octo-business + */ + html_url: string; + /** + * Format: uri + * @description The enterprise's website URL. + */ + website_url?: string | null; + /** + * @description Unique identifier of the enterprise + * @example 42 + */ + id: number; + /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + node_id: string; + /** + * @description The name of the enterprise. + * @example Octo Business + */ + name: string; + /** + * @description The slug url identifier for the enterprise. + * @example octo-business + */ + slug: string; + /** + * Format: date-time + * @example 2019-01-26T19:01:12Z + */ + created_at: string | null; + /** + * Format: date-time + * @example 2019-01-26T19:14:43Z + */ + updated_at: string | null; + /** Format: uri */ + avatar_url: string; + }; /** * Simple Installation * @description The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -24522,7 +24571,7 @@ export interface components { "webhook-branch-protection-configuration-disabled": { /** @enum {string} */ action: "disabled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -24532,7 +24581,7 @@ export interface components { "webhook-branch-protection-configuration-enabled": { /** @enum {string} */ action: "enabled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -24542,7 +24591,7 @@ export interface components { "webhook-branch-protection-rule-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -24596,7 +24645,7 @@ export interface components { "webhook-branch-protection-rule-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -24676,7 +24725,7 @@ export interface components { from: "off" | "non_admins" | "everyone"; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -25038,7 +25087,7 @@ export interface components { */ url: string; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -25279,7 +25328,7 @@ export interface components { */ url: string; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -25520,7 +25569,7 @@ export interface components { */ url: string; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -25646,7 +25695,7 @@ export interface components { }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ @@ -25781,7 +25830,7 @@ export interface components { }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ @@ -25878,7 +25927,7 @@ export interface components { }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ @@ -26015,7 +26064,7 @@ export interface components { }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ @@ -26108,7 +26157,7 @@ export interface components { }) | null; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ @@ -26194,7 +26243,7 @@ export interface components { }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ @@ -26289,7 +26338,7 @@ export interface components { url?: string; }) | null; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -26299,7 +26348,7 @@ export interface components { "webhook-create": { /** @description The repository's current description. */ description: string | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The name of the repository's default branch (usually `main`). */ master_branch: string; @@ -26318,7 +26367,7 @@ export interface components { }; /** delete event */ "webhook-delete": { - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The pusher type for the event. Can be either `user` or a deploy key. */ @@ -26340,7 +26389,7 @@ export interface components { alert: components["schemas"]["dependabot-alert"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; @@ -26351,7 +26400,7 @@ export interface components { alert: components["schemas"]["dependabot-alert"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; @@ -26362,7 +26411,7 @@ export interface components { alert: components["schemas"]["dependabot-alert"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; @@ -26373,7 +26422,7 @@ export interface components { alert: components["schemas"]["dependabot-alert"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; @@ -26384,7 +26433,7 @@ export interface components { alert: components["schemas"]["dependabot-alert"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; @@ -26395,7 +26444,7 @@ export interface components { alert: components["schemas"]["dependabot-alert"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; @@ -26406,7 +26455,7 @@ export interface components { alert: components["schemas"]["dependabot-alert"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; @@ -26414,7 +26463,7 @@ export interface components { "webhook-deploy-key-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ key: { @@ -26437,7 +26486,7 @@ export interface components { "webhook-deploy-key-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ key: { @@ -26656,7 +26705,7 @@ export interface components { /** Format: uri */ url: string; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -27004,7 +27053,7 @@ export interface components { url?: string; }; comment?: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -27376,7 +27425,7 @@ export interface components { url?: string; }; comment?: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -27727,7 +27776,7 @@ export interface components { "webhook-deployment-review-requested": { /** @enum {string} */ action: "requested"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; environment: string; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; @@ -28528,7 +28577,7 @@ export interface components { /** Format: uri */ url: string; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -28908,7 +28957,7 @@ export interface components { }) | null; }; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -28936,7 +28985,7 @@ export interface components { }; }; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -28947,7 +28996,7 @@ export interface components { /** @enum {string} */ action: "closed"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -29027,7 +29076,7 @@ export interface components { }) | null; }; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -29107,7 +29156,7 @@ export interface components { }) | null; }; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -29192,7 +29241,7 @@ export interface components { }) | null; }; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -29395,7 +29444,7 @@ export interface components { url?: string; }; }); - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -29406,7 +29455,7 @@ export interface components { /** @enum {string} */ action: "deleted"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -29425,7 +29474,7 @@ export interface components { }; }; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -29436,7 +29485,7 @@ export interface components { /** @enum {string} */ action: "labeled"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** Label */ label: { @@ -29463,7 +29512,7 @@ export interface components { /** @enum {string} */ action: "locked"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -29474,7 +29523,7 @@ export interface components { /** @enum {string} */ action: "pinned"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -29485,7 +29534,7 @@ export interface components { /** @enum {string} */ action: "reopened"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -29500,7 +29549,7 @@ export interface components { new_repository: components["schemas"]["repository-webhooks"]; }; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -29591,7 +29640,7 @@ export interface components { /** @enum {string} */ action: "unlabeled"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** Label */ label: { @@ -29618,7 +29667,7 @@ export interface components { /** @enum {string} */ action: "unlocked"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -29629,7 +29678,7 @@ export interface components { /** @enum {string} */ action: "unpinned"; discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -29640,7 +29689,7 @@ export interface components { * @description A user forks a repository. */ "webhook-fork": { - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */ forkee: ({ /** @@ -29983,7 +30032,7 @@ export interface components { "webhook-github-app-authorization-revoked": { /** @enum {string} */ action: "revoked"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -29991,7 +30040,7 @@ export interface components { }; /** gollum event */ "webhook-gollum": { - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The pages that were updated. */ @@ -30021,7 +30070,7 @@ export interface components { "webhook-installation-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description An array of repository objects that the installation can access. */ @@ -30079,7 +30128,7 @@ export interface components { "webhook-installation-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description An array of repository objects that the installation can access. */ @@ -30101,7 +30150,7 @@ export interface components { "webhook-installation-new-permissions-accepted": { /** @enum {string} */ action: "new_permissions_accepted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description An array of repository objects that the installation can access. */ @@ -30123,7 +30172,7 @@ export interface components { "webhook-installation-repositories-added": { /** @enum {string} */ action: "added"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description An array of repository objects, which were added to the installation. */ @@ -30197,7 +30246,7 @@ export interface components { "webhook-installation-repositories-removed": { /** @enum {string} */ action: "removed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description An array of repository objects, which were added to the installation. */ @@ -30271,7 +30320,7 @@ export interface components { "webhook-installation-suspend": { /** @enum {string} */ action: "suspend"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description An array of repository objects that the installation can access. */ @@ -30338,7 +30387,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -30349,7 +30398,7 @@ export interface components { "webhook-installation-unsuspend": { /** @enum {string} */ action: "unsuspend"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description An array of repository objects that the installation can access. */ @@ -30456,7 +30505,7 @@ export interface components { url?: string; }) | null; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: ({ @@ -31070,7 +31119,7 @@ export interface components { url?: string; }) | null; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: ({ @@ -31691,7 +31740,7 @@ export interface components { url?: string; }) | null; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: ({ @@ -32260,7 +32309,7 @@ export interface components { /** Format: uri */ url?: string; }) | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -32683,7 +32732,7 @@ export interface components { * @enum {string} */ action: "closed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: ({ @@ -33159,7 +33208,7 @@ export interface components { "webhook-issues-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -33579,7 +33628,7 @@ export interface components { "webhook-issues-demilestoned": { /** @enum {string} */ action: "demilestoned"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; issue: ({ /** @enum {string|null} */ @@ -34205,7 +34254,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -34641,7 +34690,7 @@ export interface components { "webhook-issues-labeled": { /** @enum {string} */ action: "labeled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -35077,7 +35126,7 @@ export interface components { "webhook-issues-locked": { /** @enum {string} */ action: "locked"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; issue: ({ /** @enum {string|null} */ @@ -35553,7 +35602,7 @@ export interface components { "webhook-issues-milestoned": { /** @enum {string} */ action: "milestoned"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; issue: ({ /** @enum {string|null} */ @@ -36815,7 +36864,7 @@ export interface components { watchers_count: number; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -37235,7 +37284,7 @@ export interface components { "webhook-issues-pinned": { /** @enum {string} */ action: "pinned"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -37655,7 +37704,7 @@ export interface components { "webhook-issues-reopened": { /** @enum {string} */ action: "reopened"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; issue: ({ /** @enum {string|null} */ @@ -38784,7 +38833,7 @@ export interface components { web_commit_signoff_required?: boolean; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -39244,7 +39293,7 @@ export interface components { /** Format: uri */ url?: string; }) | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -39664,7 +39713,7 @@ export interface components { "webhook-issues-unlabeled": { /** @enum {string} */ action: "unlabeled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -40100,7 +40149,7 @@ export interface components { "webhook-issues-unlocked": { /** @enum {string} */ action: "unlocked"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; issue: ({ /** @enum {string|null} */ @@ -40575,7 +40624,7 @@ export interface components { "webhook-issues-unpinned": { /** @enum {string} */ action: "unpinned"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Issue @@ -40995,7 +41044,7 @@ export interface components { "webhook-label-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** Label */ label: { @@ -41021,7 +41070,7 @@ export interface components { "webhook-label-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** Label */ label: { @@ -41062,7 +41111,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** Label */ label: { @@ -41089,7 +41138,7 @@ export interface components { /** @enum {string} */ action: "cancelled"; effective_date: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; marketplace_purchase: ({ account: { @@ -41178,7 +41227,7 @@ export interface components { /** @enum {string} */ action: "changed"; effective_date: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; marketplace_purchase: ({ account: { @@ -41267,7 +41316,7 @@ export interface components { /** @enum {string} */ action: "pending_change"; effective_date: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; marketplace_purchase: ({ account: { @@ -41356,7 +41405,7 @@ export interface components { /** @enum {string} */ action: "pending_change_cancelled"; effective_date: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; marketplace_purchase: ({ account: { @@ -41422,7 +41471,7 @@ export interface components { /** @enum {string} */ action: "purchased"; effective_date: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; marketplace_purchase: ({ account: { @@ -41516,7 +41565,7 @@ export interface components { to: "write" | "admin" | "read"; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** User */ member: ({ @@ -41574,7 +41623,7 @@ export interface components { to?: string | null; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** User */ member: ({ @@ -41621,7 +41670,7 @@ export interface components { "webhook-member-removed": { /** @enum {string} */ action: "removed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** User */ member: ({ @@ -41668,7 +41717,7 @@ export interface components { "webhook-membership-added": { /** @enum {string} */ action: "added"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** User */ member: ({ @@ -41818,7 +41867,7 @@ export interface components { "webhook-membership-removed": { /** @enum {string} */ action: "removed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** User */ member: ({ @@ -41991,7 +42040,7 @@ export interface components { "webhook-meta-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ hook: { active: boolean; @@ -42021,7 +42070,7 @@ export interface components { "webhook-milestone-closed": { /** @enum {string} */ action: "closed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Milestone @@ -42102,7 +42151,7 @@ export interface components { "webhook-milestone-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Milestone @@ -42183,7 +42232,7 @@ export interface components { "webhook-milestone-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Milestone @@ -42279,7 +42328,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Milestone @@ -42360,7 +42409,7 @@ export interface components { "webhook-milestone-opened": { /** @enum {string} */ action: "opened"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Milestone @@ -42478,7 +42527,7 @@ export interface components { /** Format: uri */ url?: string; }) | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -42525,7 +42574,7 @@ export interface components { /** Format: uri */ url?: string; }) | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -42535,7 +42584,7 @@ export interface components { "webhook-organization-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Membership @@ -42594,7 +42643,7 @@ export interface components { "webhook-organization-member-added": { /** @enum {string} */ action: "member_added"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Membership @@ -42653,7 +42702,7 @@ export interface components { "webhook-organization-member-invited": { /** @enum {string} */ action: "member_invited"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The invitation for the user or email if the action is `member_invited`. */ invitation: { @@ -42754,7 +42803,7 @@ export interface components { "webhook-organization-member-removed": { /** @enum {string} */ action: "member_removed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Membership @@ -42818,7 +42867,7 @@ export interface components { from?: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** * Membership @@ -42896,7 +42945,7 @@ export interface components { "webhook-package-published": { /** @enum {string} */ action: "published"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description Information about the package. */ @@ -43153,7 +43202,7 @@ export interface components { "webhook-package-updated": { /** @enum {string} */ action: "updated"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @description Information about the package. */ @@ -43402,7 +43451,7 @@ export interface components { /** Format: uri */ url: string; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; id: number; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -43507,7 +43556,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ @@ -43577,7 +43626,7 @@ export interface components { "webhook-project-card-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ @@ -43647,7 +43696,7 @@ export interface components { "webhook-project-card-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ @@ -43722,7 +43771,7 @@ export interface components { from: string | null; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ @@ -43797,7 +43846,7 @@ export interface components { from: number; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; project_card: ({ @@ -43898,7 +43947,7 @@ export interface components { "webhook-project-closed": { /** @enum {string} */ action: "closed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project */ @@ -43972,7 +44021,7 @@ export interface components { "webhook-project-column-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Column */ @@ -44001,7 +44050,7 @@ export interface components { "webhook-project-column-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Column */ @@ -44035,7 +44084,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Column */ @@ -44064,7 +44113,7 @@ export interface components { "webhook-project-column-moved": { /** @enum {string} */ action: "moved"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Column */ @@ -44093,7 +44142,7 @@ export interface components { "webhook-project-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project */ @@ -44167,7 +44216,7 @@ export interface components { "webhook-project-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project */ @@ -44252,7 +44301,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project */ @@ -44326,7 +44375,7 @@ export interface components { "webhook-project-reopened": { /** @enum {string} */ action: "reopened"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Project */ @@ -44563,7 +44612,7 @@ export interface components { }; /** public event */ "webhook-public": { - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -44610,7 +44659,7 @@ export interface components { /** Format: uri */ url?: string; }) | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -45799,7 +45848,7 @@ export interface components { "webhook-pull-request-auto-merge-disabled": { /** @enum {string} */ action: "auto_merge_disabled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; number: number; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -46988,7 +47037,7 @@ export interface components { "webhook-pull-request-auto-merge-enabled": { /** @enum {string} */ action: "auto_merge_enabled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; number: number; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -48177,7 +48226,7 @@ export interface components { "webhook-pull-request-closed": { /** @enum {string} */ action: "closed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -48238,7 +48287,7 @@ export interface components { "webhook-pull-request-converted-to-draft": { /** @enum {string} */ action: "converted_to_draft"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -48299,7 +48348,7 @@ export interface components { "webhook-pull-request-demilestoned": { /** @enum {string} */ action: "demilestoned"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; milestone?: components["schemas"]["milestone"]; /** @description The pull request number. */ number: number; @@ -49488,7 +49537,7 @@ export interface components { "webhook-pull-request-dequeued": { /** @enum {string} */ action: "dequeued"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; number: number; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -50696,7 +50745,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -50757,7 +50806,7 @@ export interface components { "webhook-pull-request-enqueued": { /** @enum {string} */ action: "enqueued"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; number: number; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -51945,7 +51994,7 @@ export interface components { "webhook-pull-request-labeled": { /** @enum {string} */ action: "labeled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** Label */ label?: { @@ -53150,7 +53199,7 @@ export interface components { "webhook-pull-request-locked": { /** @enum {string} */ action: "locked"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -54339,7 +54388,7 @@ export interface components { "webhook-pull-request-milestoned": { /** @enum {string} */ action: "milestoned"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; milestone?: components["schemas"]["milestone"]; /** @description The pull request number. */ number: number; @@ -55528,7 +55577,7 @@ export interface components { "webhook-pull-request-opened": { /** @enum {string} */ action: "opened"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -55589,7 +55638,7 @@ export interface components { "webhook-pull-request-ready-for-review": { /** @enum {string} */ action: "ready_for_review"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -55650,7 +55699,7 @@ export interface components { "webhook-pull-request-reopened": { /** @enum {string} */ action: "reopened"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -55856,7 +55905,7 @@ export interface components { url?: string; }) | null; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: { @@ -57128,7 +57177,7 @@ export interface components { url?: string; }) | null; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: { @@ -58407,7 +58456,7 @@ export interface components { url?: string; }) | null; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: { @@ -59534,7 +59583,7 @@ export interface components { "webhook-pull-request-review-dismissed": { /** @enum {string} */ action: "dismissed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ @@ -60741,7 +60790,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ @@ -61849,7 +61898,7 @@ export interface components { "webhook-pull-request-review-request-removed": OneOf<[{ /** @enum {string} */ action: "review_request_removed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -63066,7 +63115,7 @@ export interface components { }, { /** @enum {string} */ action: "review_request_removed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -64310,7 +64359,7 @@ export interface components { "webhook-pull-request-review-requested": OneOf<[{ /** @enum {string} */ action: "review_requested"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -65534,7 +65583,7 @@ export interface components { }, { /** @enum {string} */ action: "review_requested"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -66778,7 +66827,7 @@ export interface components { "webhook-pull-request-review-submitted": { /** @enum {string} */ action: "submitted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ @@ -67978,7 +68027,7 @@ export interface components { "webhook-pull-request-review-thread-resolved": { /** @enum {string} */ action: "resolved"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ @@ -69172,7 +69221,7 @@ export interface components { "webhook-pull-request-review-thread-unresolved": { /** @enum {string} */ action: "unresolved"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ @@ -70368,7 +70417,7 @@ export interface components { action: "synchronize"; after: string; before: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -71587,7 +71636,7 @@ export interface components { /** Format: uri */ url?: string; }) | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -72776,7 +72825,7 @@ export interface components { "webhook-pull-request-unlabeled": { /** @enum {string} */ action: "unlabeled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** Label */ label?: { @@ -73974,7 +74023,7 @@ export interface components { "webhook-pull-request-unlocked": { /** @enum {string} */ action: "unlocked"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ number: number; @@ -75223,7 +75272,7 @@ export interface components { created: boolean; /** @description Whether this push deleted the `ref`. */ deleted: boolean; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description Whether this push was a force push of the `ref`. */ forced: boolean; /** Commit */ @@ -75541,7 +75590,7 @@ export interface components { "webhook-registry-package-published": { /** @enum {string} */ action: "published"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; registry_package: { @@ -75737,7 +75786,7 @@ export interface components { "webhook-registry-package-updated": { /** @enum {string} */ action: "updated"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; registry_package: { @@ -75871,7 +75920,7 @@ export interface components { "webhook-release-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @@ -76028,7 +76077,7 @@ export interface components { "webhook-release-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @@ -76199,7 +76248,7 @@ export interface components { to: boolean; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @@ -76356,7 +76405,7 @@ export interface components { "webhook-release-prereleased": { /** @enum {string} */ action: "prereleased"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; release: ({ @@ -76551,7 +76600,7 @@ export interface components { "webhook-release-published": { /** @enum {string} */ action: "published"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; release: ({ @@ -76743,7 +76792,7 @@ export interface components { "webhook-release-released": { /** @enum {string} */ action: "released"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** @@ -76900,7 +76949,7 @@ export interface components { "webhook-release-unpublished": { /** @enum {string} */ action: "unpublished"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; release: ({ @@ -77091,7 +77140,7 @@ export interface components { "webhook-repository-advisory-published": { /** @enum {string} */ action: "published"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77102,7 +77151,7 @@ export interface components { "webhook-repository-advisory-reported": { /** @enum {string} */ action: "reported"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77113,7 +77162,7 @@ export interface components { "webhook-repository-archived": { /** @enum {string} */ action: "archived"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77123,7 +77172,7 @@ export interface components { "webhook-repository-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77133,7 +77182,7 @@ export interface components { "webhook-repository-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77147,7 +77196,7 @@ export interface components { client_payload: { [key: string]: unknown; } | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77171,7 +77220,7 @@ export interface components { from?: string[] | null; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77179,7 +77228,7 @@ export interface components { }; /** repository_import event */ "webhook-repository-import": { - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77191,7 +77240,7 @@ export interface components { "webhook-repository-privatized": { /** @enum {string} */ action: "privatized"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77201,7 +77250,7 @@ export interface components { "webhook-repository-publicized": { /** @enum {string} */ action: "publicized"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77218,7 +77267,7 @@ export interface components { }; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77228,7 +77277,7 @@ export interface components { "webhook-repository-ruleset-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -77239,7 +77288,7 @@ export interface components { "webhook-repository-ruleset-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -77250,7 +77299,7 @@ export interface components { "webhook-repository-ruleset-edited": { /** @enum {string} */ action: "edited"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -77376,7 +77425,7 @@ export interface components { }; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77386,7 +77435,7 @@ export interface components { "webhook-repository-unarchived": { /** @enum {string} */ action: "unarchived"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77468,7 +77517,7 @@ export interface components { /** @enum {string} */ state: "open"; }); - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77591,7 +77640,7 @@ export interface components { /** @enum {string} */ state: "dismissed"; }); - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77673,7 +77722,7 @@ export interface components { /** @enum {string} */ state: "open"; }); - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77758,7 +77807,7 @@ export interface components { /** @enum {string} */ state: "fixed" | "open"; }); - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77769,7 +77818,7 @@ export interface components { /** @enum {string} */ action: "created"; alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77796,7 +77845,7 @@ export interface components { /** @enum {string} */ action: "reopened"; alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77807,7 +77856,7 @@ export interface components { /** @enum {string} */ action: "resolved"; alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77818,7 +77867,7 @@ export interface components { /** @enum {string} */ action: "revoked"; alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -77828,7 +77877,7 @@ export interface components { "webhook-security-advisory-published": { /** @enum {string} */ action: "published"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -77875,7 +77924,7 @@ export interface components { "webhook-security-advisory-updated": { /** @enum {string} */ action: "updated"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -77922,7 +77971,7 @@ export interface components { "webhook-security-advisory-withdrawn": { /** @enum {string} */ action: "withdrawn"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -77972,7 +78021,7 @@ export interface components { security_and_analysis?: components["schemas"]["security-and-analysis"]; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["full-repository"]; @@ -77982,7 +78031,7 @@ export interface components { "webhook-sponsorship-cancelled": { /** @enum {string} */ action: "cancelled"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -78106,7 +78155,7 @@ export interface components { "webhook-sponsorship-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -78236,7 +78285,7 @@ export interface components { from: string; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -78362,7 +78411,7 @@ export interface components { action: "pending_cancellation"; /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ effective_date?: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -78507,7 +78556,7 @@ export interface components { }; /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ effective_date?: string; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -78650,7 +78699,7 @@ export interface components { }; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; @@ -78774,7 +78823,7 @@ export interface components { "webhook-star-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -78786,7 +78835,7 @@ export interface components { "webhook-star-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -78947,7 +78996,7 @@ export interface components { created_at: string; /** @description The optional human-readable description added to the status. */ description: string | null; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The unique identifier of the status. */ id: number; installation?: components["schemas"]["simple-installation"]; @@ -78968,7 +79017,7 @@ export interface components { }; /** team_add event */ "webhook-team-add": { - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -79043,7 +79092,7 @@ export interface components { "webhook-team-added-to-repository": { /** @enum {string} */ action: "added_to_repository"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; /** @@ -79352,7 +79401,7 @@ export interface components { "webhook-team-created": { /** @enum {string} */ action: "created"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; /** @@ -79661,7 +79710,7 @@ export interface components { "webhook-team-deleted": { /** @enum {string} */ action: "deleted"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; /** @@ -80001,7 +80050,7 @@ export interface components { }; }; }; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; /** @@ -80310,7 +80359,7 @@ export interface components { "webhook-team-removed-from-repository": { /** @enum {string} */ action: "removed_from_repository"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; /** @@ -80619,7 +80668,7 @@ export interface components { "webhook-watch-started": { /** @enum {string} */ action: "started"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -80627,7 +80676,7 @@ export interface components { }; /** workflow_dispatch event */ "webhook-workflow-dispatch": { - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; inputs: { [key: string]: unknown; } | null; @@ -80642,7 +80691,7 @@ export interface components { "webhook-workflow-job-completed": { /** @enum {string} */ action: "completed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -80732,7 +80781,7 @@ export interface components { "webhook-workflow-job-in-progress": { /** @enum {string} */ action: "in_progress"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -80830,7 +80879,7 @@ export interface components { "webhook-workflow-job-queued": { /** @enum {string} */ action: "queued"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -80884,7 +80933,7 @@ export interface components { "webhook-workflow-job-waiting": { /** @enum {string} */ action: "waiting"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -80938,7 +80987,7 @@ export interface components { "webhook-workflow-run-completed": { /** @enum {string} */ action: "completed"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -81625,7 +81674,7 @@ export interface components { "webhook-workflow-run-in-progress": { /** @enum {string} */ action: "in_progress"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -82312,7 +82361,7 @@ export interface components { "webhook-workflow-run-requested": { /** @enum {string} */ action: "requested"; - enterprise?: components["schemas"]["enterprise"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -83304,7 +83353,7 @@ export interface operations { * 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)." */ "security-advisories/list-global-advisories": { - parameters: { + parameters?: { query?: { /** @description If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned. */ ghsa_id?: string; @@ -83486,7 +83535,7 @@ export interface operations { * 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. */ "apps/list-webhook-deliveries": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; @@ -83550,7 +83599,7 @@ export interface operations { * @description Lists all the pending installation requests for the authenticated GitHub App. */ "apps/list-installation-requests-for-authenticated-app": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -83574,7 +83623,7 @@ export interface operations { * The permissions the installation has are included under the `permissions` key. */ "apps/list-installations": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -83972,7 +84021,7 @@ export interface operations { * @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. */ "classroom/list-classrooms": { - parameters: { + parameters?: { query?: { page?: components["parameters"]["page"]; per_page?: components["parameters"]["per-page"]; @@ -84163,7 +84212,7 @@ export interface operations { * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ "activity/list-public-events": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -84210,7 +84259,7 @@ export interface operations { * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ "gists/list": { - parameters: { + parameters?: { query?: { since?: components["parameters"]["since"]; per_page?: components["parameters"]["per-page"]; @@ -84288,7 +84337,7 @@ export interface operations { * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), 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. */ "gists/list-public": { - parameters: { + parameters?: { query?: { since?: components["parameters"]["since"]; per_page?: components["parameters"]["per-page"]; @@ -84315,7 +84364,7 @@ export interface operations { * @description List the authenticated user's starred gists: */ "gists/list-starred": { - parameters: { + parameters?: { query?: { since?: components["parameters"]["since"]; per_page?: components["parameters"]["per-page"]; @@ -84753,7 +84802,7 @@ export interface operations { * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ "apps/list-repos-accessible-to-installation": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -84808,7 +84857,7 @@ export interface operations { * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. */ "issues/list": { - parameters: { + parameters?: { query?: { /** @description 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. */ filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; @@ -84847,7 +84896,7 @@ export interface operations { * @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)." */ "licenses/get-all-commonly-used": { - parameters: { + parameters?: { query?: { featured?: boolean; per_page?: components["parameters"]["per-page"]; @@ -84980,7 +85029,7 @@ export interface operations { * 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/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-plans": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -85067,7 +85116,7 @@ export interface operations { * 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/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-plans-stubbed": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -85169,7 +85218,7 @@ export interface operations { * @description List all notifications for the current user, sorted by most recently updated. */ "activity/list-notifications-for-authenticated-user": { - parameters: { + parameters?: { query?: { all?: components["parameters"]["all"]; participating?: components["parameters"]["participating"]; @@ -85359,7 +85408,7 @@ export interface operations { * @description Get the octocat as ASCII art */ "meta/get-octocat": { - parameters: { + parameters?: { query?: { /** @description The words to show in Octocat's speech bubble */ s?: string; @@ -85381,7 +85430,7 @@ export interface operations { * **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. */ "orgs/list": { - parameters: { + parameters?: { query?: { since?: components["parameters"]["since-org"]; per_page?: components["parameters"]["per-page"]; @@ -87437,6 +87486,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + Link: components["headers"]["link"]; + }; content: { "application/json": { /** @description Total number of Copilot For Business seats for the organization currently being billed. */ @@ -106123,7 +106175,7 @@ export interface operations { * - 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. */ "repos/list-public": { - parameters: { + parameters?: { query?: { since?: components["parameters"]["since-repo"]; }; @@ -107907,7 +107959,7 @@ export interface operations { * @description List the users you've blocked on your personal account. */ "users/list-blocked-by-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -108004,7 +108056,7 @@ export interface operations { * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. */ "codespaces/list-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -108124,7 +108176,7 @@ export interface operations { * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. */ "codespaces/list-secrets-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -108694,7 +108746,7 @@ export interface operations { * @description Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */ "users/list-emails-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -108776,7 +108828,7 @@ export interface operations { * @description Lists the people following the authenticated user. */ "users/list-followers-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -108802,7 +108854,7 @@ export interface operations { * @description Lists the people who the authenticated user follows. */ "users/list-followed-by-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -108895,7 +108947,7 @@ export interface operations { * @description Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ "users/list-gpg-keys-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -109002,7 +109054,7 @@ export interface operations { * You can find the permissions for the installation under the `permissions` key. */ "apps/list-installations-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -109175,7 +109227,7 @@ export interface operations { * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. */ "issues/list-for-authenticated-user": { - parameters: { + parameters?: { query?: { /** @description 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. */ filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; @@ -109209,7 +109261,7 @@ export interface operations { * @description Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ "users/list-public-ssh-keys-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -109312,7 +109364,7 @@ export interface operations { * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). */ "apps/list-subscriptions-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -109338,7 +109390,7 @@ export interface operations { * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). */ "apps/list-subscriptions-for-authenticated-user-stubbed": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -109363,7 +109415,7 @@ export interface operations { * @description Lists all of the authenticated user's organization memberships. */ "orgs/list-memberships-for-authenticated-user": { - parameters: { + parameters?: { query?: { /** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; @@ -109446,7 +109498,7 @@ export interface operations { * @description Lists all migrations a user has started. */ "migrations/list-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -109687,7 +109739,7 @@ export interface operations { * This 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. OAuth requests with insufficient scope receive a `403 Forbidden` response. */ "orgs/list-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -109957,7 +110009,7 @@ export interface operations { * @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. This endpoint is accessible with the `user:email` scope. */ "users/list-public-emails-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -109986,7 +110038,7 @@ export interface operations { * 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. */ "repos/list-for-authenticated-user": { - parameters: { + parameters?: { query?: { /** @description Limit results to repositories with the specified visibility. */ visibility?: "all" | "public" | "private"; @@ -110195,7 +110247,7 @@ export interface operations { * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ "repos/list-invitations-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -110258,7 +110310,7 @@ export interface operations { * @description Lists all of your social accounts. */ "users/list-social-accounts-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -110343,7 +110395,7 @@ export interface operations { * @description Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." */ "users/list-ssh-signing-keys-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -110448,7 +110500,7 @@ export interface operations { * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. */ "activity/list-repos-starred-by-authenticated-user": { - parameters: { + parameters?: { query?: { sort?: components["parameters"]["sort-starred"]; direction?: components["parameters"]["direction"]; @@ -110548,7 +110600,7 @@ export interface operations { * @description Lists repositories the authenticated user is watching. */ "activity/list-watched-repos-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -110574,7 +110626,7 @@ export interface operations { * @description List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token. */ "teams/list-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -110602,7 +110654,7 @@ export interface operations { * 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. */ "users/list": { - parameters: { + parameters?: { query?: { since?: components["parameters"]["since-user"]; per_page?: components["parameters"]["per-page"]; diff --git a/packages/openapi-typescript/examples/github-api.yaml b/packages/openapi-typescript/examples/github-api.yaml index 443e4d5fc..bec7541fc 100644 --- a/packages/openapi-typescript/examples/github-api.yaml +++ b/packages/openapi-typescript/examples/github-api.yaml @@ -6519,6 +6519,9 @@ paths: examples: default: "$ref": "#/components/examples/copilot-seats-list" + headers: + Link: + "$ref": "#/components/headers/link" '500': "$ref": "#/components/responses/internal_error" '401': @@ -45019,7 +45022,9 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - **Note**: This event will not occur when more than three tags are created at once. + **Notes**: + - This event will not occur when more than three tags are created at once. + - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. operationId: create externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#create @@ -55407,7 +55412,7 @@ x-webhooks: post: summary: |- This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, - when a branch is deleted, when a tag is deleted, or when a repository is cloned. To subscribe to only branch + when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch and tag deletions, use the [`delete`](#delete) webhook event. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. @@ -83521,6 +83526,64 @@ components: required: - key - id + enterprise-webhooks: + title: Enterprise + description: | + An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured + on an enterprise account or an organization that's part of an enterprise account. For more information, + see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url simple-installation: title: Simple Installation description: |- @@ -85990,7 +86053,7 @@ components: enum: - disabled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -86012,7 +86075,7 @@ components: enum: - enabled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -86034,7 +86097,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -86187,7 +86250,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -86408,7 +86471,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -87278,7 +87341,7 @@ components: - check_runs_url - head_commit enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -87876,7 +87939,7 @@ components: - check_runs_url - head_commit enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -88468,7 +88531,7 @@ components: - check_runs_url - head_commit enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -88714,7 +88777,7 @@ components: the `sender` and this value will be empty. type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -88985,7 +89048,7 @@ components: the `sender` and this value will be empty. type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -89195,7 +89258,7 @@ components: the `sender` and this value will be empty. type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -89469,7 +89532,7 @@ components: the `sender` and this value will be empty. type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -89674,7 +89737,7 @@ components: type: string nullable: true enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -89854,7 +89917,7 @@ components: the `sender` and this value will be empty. type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -90055,7 +90118,7 @@ components: - author_association - body enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -90078,7 +90141,7 @@ components: type: string nullable: true enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" master_branch: @@ -90117,7 +90180,7 @@ components: type: object properties: enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -90161,7 +90224,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -90186,7 +90249,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -90211,7 +90274,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -90236,7 +90299,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -90261,7 +90324,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -90286,7 +90349,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -90311,7 +90374,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -90330,7 +90393,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" key: @@ -90387,7 +90450,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" key: @@ -90921,7 +90984,7 @@ components: - statuses_url - repository_url enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -91652,7 +91715,7 @@ components: comment: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -92442,7 +92505,7 @@ components: comment: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -93191,7 +93254,7 @@ components: enum: - requested enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" environment: type: string installation: @@ -95013,7 +95076,7 @@ components: - deployment_url - repository_url enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -95828,7 +95891,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -95898,7 +95961,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -95924,7 +95987,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -96103,7 +96166,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -96283,7 +96346,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -96475,7 +96538,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -96922,7 +96985,7 @@ components: - answer_chosen_at - answer_chosen_by enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -96947,7 +97010,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -96989,7 +97052,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97014,7 +97077,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: @@ -97072,7 +97135,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97097,7 +97160,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97122,7 +97185,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97157,7 +97220,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97358,7 +97421,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: @@ -97416,7 +97479,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97441,7 +97504,7 @@ components: discussion: "$ref": "#/components/schemas/discussion" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -97461,7 +97524,7 @@ components: type: object properties: enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -98139,7 +98202,7 @@ components: enum: - revoked enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -98156,7 +98219,7 @@ components: type: object properties: enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -98214,7 +98277,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: @@ -98328,7 +98391,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: @@ -98377,7 +98440,7 @@ components: enum: - new_permissions_accepted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: @@ -98426,7 +98489,7 @@ components: enum: - added enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: @@ -98571,7 +98634,7 @@ components: enum: - removed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: @@ -98722,7 +98785,7 @@ components: enum: - suspend enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: @@ -98868,7 +98931,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -98894,7 +98957,7 @@ components: enum: - unsuspend enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: @@ -99105,7 +99168,7 @@ components: - body - reactions enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -100418,7 +100481,7 @@ components: - body - reactions enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -101739,7 +101802,7 @@ components: - body - reactions enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -102957,7 +103020,7 @@ components: - login - id enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -103873,7 +103936,7 @@ components: enum: - closed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -104925,7 +104988,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -105834,7 +105897,7 @@ components: enum: - demilestoned enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -107167,7 +107230,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -108116,7 +108179,7 @@ components: enum: - labeled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -109063,7 +109126,7 @@ components: enum: - locked enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -110112,7 +110175,7 @@ components: enum: - milestoned enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -112763,7 +112826,7 @@ components: - old_issue - old_repository enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -113676,7 +113739,7 @@ components: enum: - pinned enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -114584,7 +114647,7 @@ components: enum: - reopened enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -116980,7 +117043,7 @@ components: - new_issue - new_repository enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -117958,7 +118021,7 @@ components: - login - id enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -118873,7 +118936,7 @@ components: enum: - unlabeled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -119820,7 +119883,7 @@ components: enum: - unlocked enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -120859,7 +120922,7 @@ components: enum: - unpinned enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: @@ -121767,7 +121830,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: @@ -121821,7 +121884,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: @@ -121907,7 +121970,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: @@ -121964,7 +122027,7 @@ components: effective_date: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: @@ -122210,7 +122273,7 @@ components: effective_date: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: @@ -122458,7 +122521,7 @@ components: effective_date: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: @@ -122705,7 +122768,7 @@ components: effective_date: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: @@ -122897,7 +122960,7 @@ components: effective_date: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: @@ -123155,7 +123218,7 @@ components: required: - to enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" member: @@ -123267,7 +123330,7 @@ components: type: string nullable: true enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" member: @@ -123358,7 +123421,7 @@ components: enum: - removed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" member: @@ -123448,7 +123511,7 @@ components: enum: - added enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" member: @@ -123722,7 +123785,7 @@ components: enum: - removed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" member: @@ -124046,7 +124109,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, @@ -124175,7 +124238,7 @@ components: enum: - closed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" milestone: @@ -124334,7 +124397,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" milestone: @@ -124492,7 +124555,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" milestone: @@ -124682,7 +124745,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" milestone: @@ -124842,7 +124905,7 @@ components: enum: - opened enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" milestone: @@ -125067,7 +125130,7 @@ components: - login - id enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -125157,7 +125220,7 @@ components: - login - id enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -125180,7 +125243,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" membership: @@ -125291,7 +125354,7 @@ components: enum: - member_added enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" membership: @@ -125403,7 +125466,7 @@ components: enum: - member_invited enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" invitation: @@ -125605,7 +125668,7 @@ components: enum: - member_removed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" membership: @@ -125725,7 +125788,7 @@ components: from: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" membership: @@ -125869,7 +125932,7 @@ components: enum: - published enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -126447,7 +126510,7 @@ components: enum: - updated enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -126986,7 +127049,7 @@ components: - created_at - updated_at enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" id: type: integer installation: @@ -127207,7 +127270,7 @@ components: required: - note enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -127347,7 +127410,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -127486,7 +127549,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -127640,7 +127703,7 @@ components: required: - note enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -127792,7 +127855,7 @@ components: required: - column_id enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -128001,7 +128064,7 @@ components: enum: - closed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -128145,7 +128208,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -128205,7 +128268,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -128275,7 +128338,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -128336,7 +128399,7 @@ components: enum: - moved enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -128397,7 +128460,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -128541,7 +128604,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -128705,7 +128768,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -128848,7 +128911,7 @@ components: enum: - reopened enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -129357,7 +129420,7 @@ components: type: object properties: enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -129445,7 +129508,7 @@ components: - login - id enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -131713,7 +131776,7 @@ components: enum: - auto_merge_disabled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -133977,7 +134040,7 @@ components: enum: - auto_merge_enabled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -136241,7 +136304,7 @@ components: enum: - closed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -136331,7 +136394,7 @@ components: enum: - converted_to_draft enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -136421,7 +136484,7 @@ components: enum: - demilestoned enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" milestone: "$ref": "#/components/schemas/milestone" number: @@ -138674,7 +138737,7 @@ components: enum: - dequeued enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -140971,7 +141034,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -141061,7 +141124,7 @@ components: enum: - enqueued enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -143313,7 +143376,7 @@ components: enum: - labeled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: @@ -145613,7 +145676,7 @@ components: enum: - locked enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -147879,7 +147942,7 @@ components: enum: - milestoned enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" milestone: "$ref": "#/components/schemas/milestone" number: @@ -150132,7 +150195,7 @@ components: enum: - opened enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -150222,7 +150285,7 @@ components: enum: - ready_for_review enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -150312,7 +150375,7 @@ components: enum: - reopened enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -150682,7 +150745,7 @@ components: - side - reactions enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -153118,7 +153181,7 @@ components: - side - reactions enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -155554,7 +155617,7 @@ components: - side - reactions enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -157701,7 +157764,7 @@ components: enum: - dismissed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -160021,7 +160084,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -162210,7 +162273,7 @@ components: enum: - review_request_removed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -164537,7 +164600,7 @@ components: enum: - review_request_removed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -166917,7 +166980,7 @@ components: enum: - review_requested enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -169249,7 +169312,7 @@ components: enum: - review_requested enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -171605,7 +171668,7 @@ components: enum: - submitted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -173911,7 +173974,7 @@ components: enum: - resolved enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -176262,7 +176325,7 @@ components: enum: - unresolved enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -178601,7 +178664,7 @@ components: before: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -180927,7 +180990,7 @@ components: - login - id enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -183195,7 +183258,7 @@ components: enum: - unlabeled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: @@ -185485,7 +185548,7 @@ components: enum: - unlocked enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: @@ -187849,7 +187912,7 @@ components: description: Whether this push deleted the `ref`. type: boolean enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -188447,7 +188510,7 @@ components: enum: - published enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -188962,7 +189025,7 @@ components: enum: - updated enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -189335,7 +189398,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -189661,7 +189724,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -190017,7 +190080,7 @@ components: required: - to enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -190343,7 +190406,7 @@ components: enum: - prereleased enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -190758,7 +190821,7 @@ components: enum: - published enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -191170,7 +191233,7 @@ components: enum: - released enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -191495,7 +191558,7 @@ components: enum: - unpublished enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -191906,7 +191969,7 @@ components: enum: - published enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -191930,7 +191993,7 @@ components: enum: - reported enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -191954,7 +192017,7 @@ components: enum: - archived enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -191976,7 +192039,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -191998,7 +192061,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192026,7 +192089,7 @@ components: nullable: true additionalProperties: true enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192085,7 +192148,7 @@ components: items: type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192104,7 +192167,7 @@ components: type: object properties: enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192132,7 +192195,7 @@ components: enum: - privatized enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192154,7 +192217,7 @@ components: enum: - publicized enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192193,7 +192256,7 @@ components: required: - repository enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192216,7 +192279,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192240,7 +192303,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192264,7 +192327,7 @@ components: enum: - edited enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192515,7 +192578,7 @@ components: required: - owner enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192538,7 +192601,7 @@ components: enum: - unarchived enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192715,7 +192778,7 @@ components: required: - state enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -192973,7 +193036,7 @@ components: - dismissed_at - state enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -193151,7 +193214,7 @@ components: required: - state enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -193335,7 +193398,7 @@ components: required: - state enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -193360,7 +193423,7 @@ components: alert: "$ref": "#/components/schemas/secret-scanning-alert-webhook" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -193419,7 +193482,7 @@ components: alert: "$ref": "#/components/schemas/secret-scanning-alert-webhook" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -193443,7 +193506,7 @@ components: alert: "$ref": "#/components/schemas/secret-scanning-alert-webhook" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -193467,7 +193530,7 @@ components: alert: "$ref": "#/components/schemas/secret-scanning-alert-webhook" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -193489,7 +193552,7 @@ components: enum: - published enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -193620,7 +193683,7 @@ components: enum: - updated enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -193751,7 +193814,7 @@ components: enum: - withdrawn enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -193885,7 +193948,7 @@ components: security_and_analysis: "$ref": "#/components/schemas/security-and-analysis" enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -193906,7 +193969,7 @@ components: enum: - cancelled enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -194150,7 +194213,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -194406,7 +194469,7 @@ components: required: - from enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -194656,7 +194719,7 @@ components: effect. type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -194948,7 +195011,7 @@ components: effect. type: string enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195236,7 +195299,7 @@ components: required: - tier enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195481,7 +195544,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195510,7 +195573,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -195871,7 +195934,7 @@ components: type: string nullable: true enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" id: description: The unique identifier of the status. type: integer @@ -195921,7 +195984,7 @@ components: type: object properties: enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -196057,7 +196120,7 @@ components: enum: - added_to_repository enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -196638,7 +196701,7 @@ components: enum: - created enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -197220,7 +197283,7 @@ components: enum: - deleted enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -197866,7 +197929,7 @@ components: required: - permissions enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -198449,7 +198512,7 @@ components: enum: - removed_from_repository enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -199031,7 +199094,7 @@ components: enum: - started enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -199049,7 +199112,7 @@ components: type: object properties: enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" inputs: type: object nullable: true @@ -199081,7 +199144,7 @@ components: enum: - completed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -199337,7 +199400,7 @@ components: enum: - in_progress enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -199616,7 +199679,7 @@ components: enum: - queued enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -199774,7 +199837,7 @@ components: enum: - waiting enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -199933,7 +199996,7 @@ components: enum: - completed enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -201363,7 +201426,7 @@ components: enum: - in_progress enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -202793,7 +202856,7 @@ components: enum: - requested enterprise: - "$ref": "#/components/schemas/enterprise" + "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: diff --git a/packages/openapi-typescript/examples/octokit-ghes-3.6-diff-to-api.ts b/packages/openapi-typescript/examples/octokit-ghes-3.6-diff-to-api.ts index 2a9ccd3a2..c680e13ef 100644 --- a/packages/openapi-typescript/examples/octokit-ghes-3.6-diff-to-api.ts +++ b/packages/openapi-typescript/examples/octokit-ghes-3.6-diff-to-api.ts @@ -5815,7 +5815,7 @@ export interface operations { /** List global webhooks */ "enterprise-admin/list-global-webhooks": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -5962,7 +5962,7 @@ export interface operations { }; /** List public keys */ "enterprise-admin/list-public-keys": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -6143,7 +6143,7 @@ export interface operations { }; /** List pre-receive environments */ "enterprise-admin/list-pre-receive-environments": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -6335,7 +6335,7 @@ export interface operations { }; /** List pre-receive hooks */ "enterprise-admin/list-pre-receive-hooks": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -6459,7 +6459,7 @@ export interface operations { * @description Lists personal access tokens for all users, including admin users. */ "enterprise-admin/list-personal-access-tokens": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -6623,7 +6623,7 @@ export interface operations { * The permissions the installation has are included under the `permissions` key. */ "apps/list-installations": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -6714,7 +6714,7 @@ export interface operations { * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ "oauth-authorizations/list-grants": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -6901,7 +6901,7 @@ export interface operations { * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ "oauth-authorizations/list-authorizations": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -9233,7 +9233,7 @@ export interface operations { * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. */ "repos/list-public": { - parameters: { + parameters?: { query?: { since?: components["parameters"]["since-repo"]; /** @description Specifies the types of repositories to return. This endpoint will only list repositories available to all users on the enterprise. */ @@ -9908,7 +9908,7 @@ export interface operations { * You can find the permissions for the installation under the `permissions` key. */ "apps/list-installations-for-authenticated-user": { - parameters: { + parameters?: { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; diff --git a/packages/openapi-typescript/examples/stripe-api.ts b/packages/openapi-typescript/examples/stripe-api.ts index cc252740c..e9f59c4d8 100644 --- a/packages/openapi-typescript/examples/stripe-api.ts +++ b/packages/openapi-typescript/examples/stripe-api.ts @@ -675,17 +675,17 @@ export interface paths { post: operations["PostFileLinksLink"]; }; "/v1/files": { - /** @description

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ + /** @description

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.

*/ get: operations["GetFiles"]; /** - * @description

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

+ * @description

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

* - *

All of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.

+ *

All of Stripe’s officially supported Client libraries support sending multipart/form-data.

*/ post: operations["PostFiles"]; }; "/v1/files/{file}": { - /** @description

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ + /** @description

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

*/ get: operations["GetFilesFile"]; }; "/v1/financial_connections/accounts": { @@ -884,15 +884,15 @@ export interface paths { }; "/v1/issuing/authorizations/{authorization}/approve": { /** - * @description

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. - * You can also respond directly to the webhook request to approve an authorization (preferred). More details can be found here.

+ * @description

[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. + * This method is deprecated. Instead, respond directly to the webhook request to approve an authorization.

*/ post: operations["PostIssuingAuthorizationsAuthorizationApprove"]; }; "/v1/issuing/authorizations/{authorization}/decline": { /** - * @description

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow. - * You can also respond directly to the webhook request to decline an authorization (preferred). More details can be found here.

+ * @description

[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow. + * This method is deprecated. Instead, respond directly to the webhook request to decline an authorization.

*/ post: operations["PostIssuingAuthorizationsAuthorizationDecline"]; }; @@ -1026,10 +1026,10 @@ export interface paths { /** * @description

Updates properties on a PaymentIntent object without confirming.

* - *

Depending on which properties you update, you may need to confirm the - * PaymentIntent again. For example, updating the payment_method will - * always require you to confirm the PaymentIntent again. If you prefer to - * update and confirm at the same time, we recommend updating properties via + *

Depending on which properties you update, you might need to confirm the + * PaymentIntent again. For example, updating the payment_method + * always requires you to confirm the PaymentIntent again. If you prefer to + * update and confirm at the same time, we recommend updating properties through * the confirm API instead.

*/ post: operations["PostPaymentIntentsIntent"]; @@ -1135,6 +1135,18 @@ export interface paths { /** @description

When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

*/ get: operations["GetPaymentLinksPaymentLinkLineItems"]; }; + "/v1/payment_method_configurations": { + /** @description

List payment method configurations

*/ + get: operations["GetPaymentMethodConfigurations"]; + /** @description

Creates a payment method configuration

*/ + post: operations["PostPaymentMethodConfigurations"]; + }; + "/v1/payment_method_configurations/{configuration}": { + /** @description

Retrieve payment method configuration

*/ + get: operations["GetPaymentMethodConfigurationsConfiguration"]; + /** @description

Update payment method configuration

*/ + post: operations["PostPaymentMethodConfigurationsConfiguration"]; + }; "/v1/payment_method_domains": { /** @description

Lists the details of existing payment method domains.

*/ get: operations["GetPaymentMethodDomains"]; @@ -1425,7 +1437,7 @@ export interface paths { post: operations["PostReviewsReviewApprove"]; }; "/v1/setup_attempts": { - /** @description

Returns a list of SetupAttempts associated with a provided SetupIntent.

*/ + /** @description

Returns a list of SetupAttempts that associate with a provided SetupIntent.

*/ get: operations["GetSetupAttempts"]; }; "/v1/setup_intents": { @@ -2884,16 +2896,16 @@ export interface components { /** * BalanceTransaction * @description Balance transactions represent funds moving through your Stripe account. - * They're created for every type of transaction that comes into or flows out of your Stripe account balance. + * Stripe creates them for every type of transaction that enters or leaves your Stripe account balance. * * Related guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types) */ balance_transaction: { - /** @description Gross amount of the transaction, in cents (or local equivalent). */ + /** @description Gross amount of the transaction (in cents (or local equivalent)). */ amount: number; /** * Format: unix-time - * @description The date the transaction's net funds will become available in the Stripe balance. + * @description The date that the transaction's net funds become available in the Stripe balance. */ available_on: number; /** @@ -2905,7 +2917,7 @@ export interface components { currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; - /** @description The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` would be `1.234`. */ + /** @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`. */ exchange_rate?: number | null; /** @description Fees (in cents (or local equivalent)) paid for this transaction. */ fee: number; @@ -2913,21 +2925,21 @@ export interface components { fee_details: components["schemas"]["fee"][]; /** @description Unique identifier for the object. */ id: string; - /** @description Net amount of the transaction, in cents (or local equivalent). */ + /** @description Net amount of the transaction (in cents (or local equivalent)). */ net: number; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "balance_transaction"; - /** @description [Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting categories can help you understand balance transactions from an accounting perspective. */ + /** @description Learn more about how [reporting categories] (https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective. */ reporting_category: string; - /** @description The Stripe object to which this transaction is related. */ + /** @description This transaction relates to the Stripe object. */ source?: (string | components["schemas"]["application_fee"] | components["schemas"]["charge"] | components["schemas"]["connect_collection_transfer"] | components["schemas"]["customer_cash_balance_transaction"] | components["schemas"]["dispute"] | components["schemas"]["fee_refund"] | components["schemas"]["issuing.authorization"] | components["schemas"]["issuing.dispute"] | components["schemas"]["issuing.transaction"] | components["schemas"]["payout"] | components["schemas"]["platform_tax_fee"] | components["schemas"]["refund"] | components["schemas"]["reserve_transaction"] | components["schemas"]["tax_deducted_at_source"] | components["schemas"]["topup"] | components["schemas"]["transfer"] | components["schemas"]["transfer_reversal"]) | null; - /** @description If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`. */ + /** @description The transaction's net funds status in the Stripe balance, which are either `available` or `pending`. */ status: string; /** - * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `payout`, `payout_cancel`, `payout_failure`, `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](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead. + * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `payout`, `payout_cancel`, `payout_failure`, `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 {string} */ type: "adjustment" | "advance" | "advance_funding" | "anticipation_repayment" | "application_fee" | "application_fee_refund" | "charge" | "connect_collection_transfer" | "contribution" | "issuing_authorization_hold" | "issuing_authorization_release" | "issuing_dispute" | "issuing_transaction" | "obligation_inbound" | "obligation_outbound" | "obligation_payout" | "obligation_payout_failure" | "obligation_reversal_inbound" | "obligation_reversal_outbound" | "payment" | "payment_failure_refund" | "payment_refund" | "payment_reversal" | "payout" | "payout_cancel" | "payout_failure" | "refund" | "refund_failure" | "reserve_transaction" | "reserved_funds" | "stripe_fee" | "stripe_fx_fee" | "tax_fee" | "topup" | "topup_reversal" | "transfer" | "transfer_cancel" | "transfer_failure" | "transfer_refund"; @@ -3635,6 +3647,8 @@ export interface components { * @enum {string|null} */ payment_method_collection?: "always" | "if_required" | null; + /** @description Information about the payment method configuration used for this Checkout session if using dynamic payment methods. */ + payment_method_configuration_details?: components["schemas"]["payment_method_config_biz_payment_method_configuration_details"] | null; /** @description Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. */ payment_method_options?: components["schemas"]["checkout_session_payment_method_options"] | null; /** @@ -4117,10 +4131,10 @@ export interface components { }; /** ConnectEmbeddedAccountSessionCreateComponents */ connect_embedded_account_session_create_components: { - account_onboarding: components["schemas"]["connect_embedded_base_config"]; + account_onboarding: components["schemas"]["connect_embedded_base_config_claim"]; }; - /** ConnectEmbeddedBaseConfig */ - connect_embedded_base_config: { + /** ConnectEmbeddedBaseConfigClaim */ + connect_embedded_base_config_claim: { /** @description Whether the embedded component is enabled. */ enabled: boolean; }; @@ -4436,16 +4450,16 @@ export interface components { }; /** * Customer - * @description This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer. + * @description This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer. * * Related guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment) */ customer: { /** @description The customer's address. */ address?: components["schemas"]["address"] | null; - /** @description Current balance, if any, being 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 will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized. */ + /** @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. */ balance?: number; - /** @description The current funds being held by Stripe on behalf of the customer. These funds can be applied towards payment intents with source "cash_balance". The settings[reconciliation_mode] field describes whether these funds are applied to such payment intents manually or automatically. */ + /** @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. */ cash_balance?: components["schemas"]["cash_balance"] | null; /** * Format: unix-time @@ -4457,13 +4471,13 @@ export interface components { /** * @description ID of the default payment source for the customer. * - * If you are using payment methods created via 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. + * If 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. */ default_source?: (string | components["schemas"]["bank_account"] | components["schemas"]["card"] | components["schemas"]["source"]) | null; /** - * @description When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date. + * @description If Stripe bills the customer's latest invoice by automatically charging and the latest charge fails, it sets `delinquent`` to `true``. If Stripe bills the invoice by sending it, and the invoice isn't paid by the due date, it also sets `delinquent`` to `true`. * - * If an invoice is marked uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't get reset to `false`. + * If an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`. */ delinquent?: boolean | null; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ @@ -4474,7 +4488,7 @@ export interface components { email?: string | null; /** @description Unique identifier for the object. */ id: string; - /** @description The current multi-currency balances, if any, being 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 will be added to their next invoice denominated in that currency. These balances do not refer to any unpaid invoices. They solely track amounts that have yet to be successfully applied to any invoice. A balance in a particular currency is only applied to any invoice as an invoice in that currency is finalized. */ + /** @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. */ invoice_credit_balance?: { [key: string]: number; }; @@ -4489,7 +4503,7 @@ export interface components { }; /** @description The customer's full name or business name. */ name?: string | null; - /** @description The suffix of the customer's next invoice number, e.g., 0001. */ + /** @description The suffix of the customer's next invoice number (for example, 0001). */ next_invoice_sequence?: number; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -4538,7 +4552,7 @@ export interface components { }; tax?: components["schemas"]["customer_tax"]; /** - * @description Describes the customer's tax exemption status. One of `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the text **"Reverse charge"**. + * @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 {string|null} */ tax_exempt?: "exempt" | "none" | "reverse" | null; @@ -4559,20 +4573,20 @@ export interface components { /** @description The URL where this list can be accessed. */ url: string; }; - /** @description ID of the test clock this customer belongs to. */ + /** @description ID of the test clock that this customer belongs to. */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; }; /** customer_acceptance */ customer_acceptance: { /** * Format: unix-time - * @description The time at which the customer accepted the Mandate. + * @description The time that the customer accepts the mandate. */ accepted_at?: number | null; offline?: components["schemas"]["offline_acceptance"]; online?: components["schemas"]["online_acceptance"]; /** - * @description The type of customer acceptance information included with the Mandate. One of `online` or `offline`. + * @description The mandate includes the type of customer acceptance information, such as: `online` or `offline`. * @enum {string} */ type: "offline" | "online"; @@ -5199,19 +5213,17 @@ export interface components { /** * Dispute * @description A dispute occurs when a customer questions your charge with their card issuer. - * When this happens, you're given the opportunity to respond to the dispute with - * evidence that shows that the charge is legitimate. You can find more - * information about the dispute process in our [Disputes and - * Fraud](/docs/disputes) documentation. + * When this happens, you have the opportunity to respond to the dispute with + * evidence that shows that the charge is legitimate. * * Related guide: [Disputes and fraud](https://stripe.com/docs/disputes) */ dispute: { - /** @description Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed). */ + /** @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). */ amount: number; /** @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. */ balance_transactions: components["schemas"]["balance_transaction"][]; - /** @description ID of the charge that was disputed. */ + /** @description ID of the charge that's disputed. */ charge: string | components["schemas"]["charge"]; /** * Format: unix-time @@ -5224,7 +5236,7 @@ export interface components { evidence_details: components["schemas"]["dispute_evidence_details"]; /** @description Unique identifier for the object. */ id: string; - /** @description If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute. */ + /** @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. */ is_charge_refundable: boolean; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; @@ -5237,10 +5249,10 @@ export interface components { * @enum {string} */ object: "dispute"; - /** @description ID of the PaymentIntent that was disputed. */ + /** @description ID of the PaymentIntent that's disputed. */ payment_intent?: (string | components["schemas"]["payment_intent"]) | null; payment_method_details?: components["schemas"]["dispute_payment_method_details"]; - /** @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`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories). */ + /** @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). */ reason: string; /** * @description Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`. @@ -5379,37 +5391,38 @@ export interface components { * @description Events are our way of letting you know when something interesting happens in * your account. When an interesting event occurs, we create a new `Event` * object. For example, when a charge succeeds, we create a `charge.succeeded` - * event; and when an invoice payment attempt fails, we create an - * `invoice.payment_failed` event. Note that many API requests may cause multiple - * events to be created. For example, if you create a new subscription for a - * customer, you will receive both a `customer.subscription.created` event and a + * event, and when an invoice payment attempt fails, we create an + * `invoice.payment_failed` event. Certain API requests might create multiple + * events. For example, if you create a new subscription for a + * customer, you receive both a `customer.subscription.created` event and a * `charge.succeeded` event. * - * Events occur when the state of another API resource changes. The state of that - * resource at the time of the change is embedded in the event's data field. For - * example, a `charge.succeeded` event will contain a charge, and an - * `invoice.payment_failed` event will contain an invoice. + * Events occur when the state of another API resource changes. The event's data + * field embeds the resource's state at the time of the change. For + * example, a `charge.succeeded` event contains a charge, and an + * `invoice.payment_failed` event contains an invoice. * * As with other API resources, you can use endpoints to retrieve an * [individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events) * from the API. We also have a separate * [webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the - * `Event` objects directly to an endpoint on your server. Webhooks are managed - * in your - * [account settings](https://dashboard.stripe.com/account/webhooks), - * and our [Using Webhooks](https://stripe.com/docs/webhooks) guide will help you get set up. + * `Event` objects directly to an endpoint on your server. You can manage + * webhooks in your + * [account settings](https://dashboard.stripe.com/account/webhooks). Learn how + * to [listen for events] + * (/docs/webhooks) so that your integration can automatically trigger reactions. * - * When using [Connect](https://stripe.com/docs/connect), you can also receive notifications of - * events that occur in connected accounts. For these events, there will be an + * When using [Connect](https://stripe.com/docs/connect), you can also receive event notifications + * that occur in connected accounts. For these events, there's an * additional `account` attribute in the received `Event` object. * - * **NOTE:** Right now, access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event) is - * guaranteed only for 30 days. + * We only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event) + * for 30 days. */ event: { - /** @description The connected account that originated the event. */ + /** @description The connected account that originates the event. */ account?: string; - /** @description The Stripe API version used to render `data`. *Note: This property is populated only for events on or after October 31, 2014*. */ + /** @description The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014. */ api_version?: string | null; /** * Format: unix-time @@ -5426,11 +5439,11 @@ export interface components { * @enum {string} */ object: "event"; - /** @description Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified. */ + /** @description Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify. */ pending_webhooks: number; - /** @description Information on the API request that instigated the event. */ + /** @description Information on the API request that triggers the event. */ request?: components["schemas"]["notification_event_request"] | null; - /** @description Description of the event (e.g., `invoice.created` or `charge.refunded`). */ + /** @description Description of the event (for example, `invoice.created` or `charge.refunded`). */ type: string; }; /** @@ -5522,10 +5535,10 @@ export interface components { }; /** * File - * @description This is an object representing a file hosted on Stripe's servers. The - * file may have been uploaded by yourself using the [create file](https://stripe.com/docs/api#create_file) - * request (for example, when uploading dispute evidence) or it may have - * been created by Stripe (for example, the results of a [Sigma scheduled + * @description This object represents files hosted on Stripe's servers. You can upload + * files with the [create file](https://stripe.com/docs/api#create_file) request + * (for example, when uploading dispute evidence). Stripe also + * creates files independetly (for example, the results of a [Sigma scheduled * query](#scheduled_queries)). * * Related guide: [File upload guide](https://stripe.com/docs/file-upload) @@ -5538,10 +5551,10 @@ export interface components { created: number; /** * Format: unix-time - * @description The time at which the file expires and is no longer available in epoch seconds. + * @description The file expires and isn't available at this time in epoch seconds. */ expires_at?: number | null; - /** @description A filename for the file, suitable for saving to a filesystem. */ + /** @description The suitable name for saving the file to a filesystem. */ filename?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -5572,19 +5585,19 @@ export interface components { * @enum {string} */ purpose: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "document_provider_identity_document" | "finance_report_run" | "identity_document" | "identity_document_downloadable" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; - /** @description The size in bytes of the file object. */ + /** @description The size of the file object in bytes. */ size: number; - /** @description A user friendly title for the document. */ + /** @description A suitable title for the document. */ title?: string | null; - /** @description The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`). */ + /** @description The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`). */ type?: string | null; - /** @description The URL from which the file can be downloaded using your live secret API key. */ + /** @description Use your live secret API key to download the file from this URL. */ url?: string | null; }; /** * FileLink * @description To share the contents of a `File` object with non-Stripe users, you can - * create a `FileLink`. `FileLink`s contain a URL that can be used to + * create a `FileLink`. `FileLink`s contain a URL that you can use to * retrieve the contents of the file without authentication. */ file_link: { @@ -5593,11 +5606,11 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Whether this link is already expired. */ + /** @description Returns if the link is already expired. */ expired: boolean; /** * Format: unix-time - * @description Time at which the link expires. + * @description Time that the link expires. */ expires_at?: number | null; /** @description The file object this link points to. */ @@ -6509,6 +6522,8 @@ export interface components { quote?: (string | components["schemas"]["quote"]) | null; /** @description This is the transaction number that appears on email receipts sent for this invoice. */ receipt_number?: string | null; + /** @description The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. */ + rendering?: components["schemas"]["invoices_invoice_rendering"] | null; /** @description Options for invoice PDF rendering. */ rendering_options?: components["schemas"]["invoice_setting_rendering_options"] | null; /** @description The details of the cost of shipping, including the ShippingRate applied on the invoice. */ @@ -6668,6 +6683,14 @@ export interface components { /** @description Data features requested to be retrieved upon account creation. */ prefetch?: "balances"[] | null; }; + /** InvoiceRenderingPdf */ + invoice_rendering_pdf: { + /** + * @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 {string|null} + */ + page_size?: "a4" | "auto" | "letter" | null; + }; /** InvoiceSettingCustomField */ invoice_setting_custom_field: { /** @description The name of the custom field. */ @@ -6813,6 +6836,13 @@ export interface components { /** @description The invoice that was cloned. */ invoice: string | components["schemas"]["invoice"]; }; + /** InvoicesInvoiceRendering */ + invoices_invoice_rendering: { + /** @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ + amount_tax_display?: string | null; + /** @description Invoice pdf rendering options */ + pdf?: components["schemas"]["invoice_rendering_pdf"] | null; + }; /** InvoicesPaymentMethodOptions */ invoices_payment_method_options: { /** @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. */ @@ -7398,7 +7428,7 @@ export interface components { eta?: number | null; /** @description Recipient name. */ name: string; - /** @description The phone number of the receiver of the bulk shipment. This phone number will be provided to the shipping company, who might use it to contact the receiver in case of delivery issues. */ + /** @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. */ phone_number?: string | null; /** @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. */ require_signature?: boolean | null; @@ -8044,7 +8074,7 @@ export interface components { }; /** * Mandate - * @description A Mandate is a record of the permission a customer has given you to debit their payment method. + * @description A Mandate is a record of the permission that your customer gives you to debit their payment method. */ mandate: { customer_acceptance: components["schemas"]["customer_acceptance"]; @@ -8058,14 +8088,14 @@ export interface components { * @enum {string} */ object: "mandate"; - /** @description The account (if any) for which the mandate is intended. */ + /** @description The account (if any) that the mandate is intended for. */ on_behalf_of?: string; /** @description ID of the payment method associated with this mandate. */ payment_method: string | components["schemas"]["payment_method"]; payment_method_details: components["schemas"]["mandate_payment_method_details"]; single_use?: components["schemas"]["mandate_single_use"]; /** - * @description The status of the mandate, which indicates whether it can be used to initiate a payment. + * @description The mandate status indicates whether or not you can use it to initiate a payment. * @enum {string} */ status: "active" | "inactive" | "pending"; @@ -8125,7 +8155,7 @@ export interface components { link?: components["schemas"]["mandate_link"]; paypal?: components["schemas"]["mandate_paypal"]; sepa_debit?: components["schemas"]["mandate_sepa_debit"]; - /** @description The type of the payment method associated with this mandate. An additional hash is included on `payment_method_details` with a name matching this value. It contains mandate information specific to the payment method. */ + /** @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. */ type: string; us_bank_account?: components["schemas"]["mandate_us_bank_account"]; }; @@ -8145,9 +8175,9 @@ export interface components { }; /** mandate_single_use */ mandate_single_use: { - /** @description On a single use mandate, the amount of the payment. */ + /** @description The amount of the payment on a single use mandate. */ amount: number; - /** @description On a single use mandate, the currency of the payment. */ + /** @description The currency of the payment on a single use mandate. */ currency: string; }; /** mandate_us_bank_account */ @@ -8177,9 +8207,9 @@ export interface components { offline_acceptance: Record; /** online_acceptance */ online_acceptance: { - /** @description The IP address from which the Mandate was accepted by the customer. */ + /** @description The customer accepts the mandate from this IP address. */ ip_address?: string | null; - /** @description The user agent of the browser from which the Mandate was accepted by the customer. */ + /** @description The customer accepts the mandate using the user agent of the browser. */ user_agent?: string | null; }; /** OutboundPaymentsPaymentMethodDetails */ @@ -8429,6 +8459,8 @@ export interface components { on_behalf_of?: (string | components["schemas"]["account"]) | null; /** @description ID of the payment method used in this PaymentIntent. */ payment_method?: (string | components["schemas"]["payment_method"]) | null; + /** @description Information about the payment method configuration used for this PaymentIntent. */ + payment_method_configuration_details?: components["schemas"]["payment_method_config_biz_payment_method_configuration_details"] | null; /** @description Payment-method-specific configuration for this PaymentIntent. */ payment_method_options?: components["schemas"]["payment_intent_payment_method_options"] | null; /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ @@ -9148,10 +9180,12 @@ export interface components { shipping_address?: components["schemas"]["payment_links_resource_custom_text_position"] | null; /** @description Custom text that should be displayed alongside the payment confirmation button. */ submit?: components["schemas"]["payment_links_resource_custom_text_position"] | null; + /** @description Custom text that should be displayed in place of the default terms of service agreement text. */ + terms_of_service_acceptance?: components["schemas"]["payment_links_resource_custom_text_position"] | null; }; /** PaymentLinksResourceCustomTextPosition */ payment_links_resource_custom_text_position: { - /** @description Text may be up to 1000 characters in length. */ + /** @description Text may be up to 1200 characters in length. */ message: string; }; /** PaymentLinksResourceInvoiceCreation */ @@ -9483,6 +9517,96 @@ export interface components { /** @description A public identifier for buyers using Cash App. */ cashtag?: string | null; }; + /** PaymentMethodConfigBizPaymentMethodConfigurationDetails */ + payment_method_config_biz_payment_method_configuration_details: { + /** @description ID of the payment method configuration used. */ + id: string; + /** @description ID of the parent payment method configuration used. */ + parent?: string | null; + }; + /** PaymentMethodConfigResourceDisplayPreference */ + payment_method_config_resource_display_preference: { + /** @description For child configurations, whether or not the account's preference will be observed. If `false`, the parent configuration's preference is used. */ + overridable?: boolean | null; + /** + * @description The account's display preference. + * @enum {string} + */ + preference: "none" | "off" | "on"; + /** + * @description The effective display preference value. + * @enum {string} + */ + value: "off" | "on"; + }; + /** PaymentMethodConfigResourcePaymentMethodProperties */ + payment_method_config_resource_payment_method_properties: { + /** @description Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. */ + available: boolean; + display_preference: components["schemas"]["payment_method_config_resource_display_preference"]; + }; + /** + * PaymentMethodConfigResourcePaymentMethodConfiguration + * @description An object detailing payment method configurations. + */ + payment_method_configuration: { + acss_debit?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + /** @description Whether the configuration can be used for new payments. */ + active: boolean; + affirm?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + afterpay_clearpay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + alipay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + apple_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + /** @description The Connect application associated with this configuration. */ + application?: string | null; + au_becs_debit?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + bacs_debit?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + bancontact?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + blik?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + boleto?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + card?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + cartes_bancaires?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + cashapp?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + eps?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + fpx?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + giropay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + google_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + grabpay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + /** @description Unique identifier for the object. */ + id: string; + id_bank_transfer?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + ideal?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + /** @description The default configuration is used whenever no payment method configuration is specified. */ + is_default: boolean; + jcb?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + klarna?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + konbini?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + link?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + multibanco?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + /** @description Configuration name. */ + name: string; + netbanking?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "payment_method_configuration"; + oxxo?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + p24?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + /** @description The configuration's parent configuration. */ + parent?: string | null; + pay_by_bank?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + paynow?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + paypal?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + promptpay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + sepa_debit?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + sofort?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + upi?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + us_bank_account?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + wechat_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + }; /** payment_method_customer_balance */ payment_method_customer_balance: Record; /** payment_method_details */ @@ -10941,10 +11065,12 @@ export interface components { shipping_address?: components["schemas"]["payment_pages_checkout_session_custom_text_position"] | null; /** @description Custom text that should be displayed alongside the payment confirmation button. */ submit?: components["schemas"]["payment_pages_checkout_session_custom_text_position"] | null; + /** @description Custom text that should be displayed in place of the default terms of service agreement text. */ + terms_of_service_acceptance?: components["schemas"]["payment_pages_checkout_session_custom_text_position"] | null; }; /** PaymentPagesCheckoutSessionCustomTextPosition */ payment_pages_checkout_session_custom_text_position: { - /** @description Text may be up to 1000 characters in length. */ + /** @description Text may be up to 1200 characters in length. */ message: string; }; /** PaymentPagesCheckoutSessionCustomerDetails */ @@ -11164,7 +11290,7 @@ export interface components { * A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. * See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform prefilling and account onboarding steps. * - * Related guide: [Handling identity verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information) + * Related guide: [Handling identity verification with the API](https://stripe.com/docs/connect/handling-api-verification#person-information) */ person: { /** @description The account the person is associated with. */ @@ -12502,7 +12628,7 @@ export interface components { /** * PaymentFlowsSetupIntentSetupAttempt * @description A SetupAttempt describes one attempted confirmation of a SetupIntent, - * whether that confirmation was successful or unsuccessful. You can use + * whether that confirmation is successful or unsuccessful. You can use * SetupAttempts to inspect details of a specific attempt at setting up a * payment method using a SetupIntent. */ @@ -12802,6 +12928,8 @@ export interface components { on_behalf_of?: (string | components["schemas"]["account"]) | null; /** @description ID of the payment method used with this SetupIntent. */ payment_method?: (string | components["schemas"]["payment_method"]) | null; + /** @description Information about the payment method configuration used for this Setup Intent. */ + payment_method_configuration_details?: components["schemas"]["payment_method_config_biz_payment_method_configuration_details"] | null; /** @description Payment-method-specific configuration for this SetupIntent. */ payment_method_options?: components["schemas"]["setup_intent_payment_method_options"] | null; /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. */ @@ -14369,10 +14497,10 @@ export interface components { }; /** * tax_id - * @description You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers). - * A customer's tax IDs are displayed on invoices and credit notes issued for the customer. + * @description You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account. + * Customer and account tax IDs get displayed on related invoices and credit notes. * - * Related guide: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids) + * Related 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) */ tax_id: { /** @description Two-letter ISO code representing the country of the tax ID. */ @@ -16379,7 +16507,7 @@ export interface operations { /** @description

Retrieves the details of an account.

*/ GetAccount: { - parameters: { + parameters?: { query?: { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -16485,7 +16613,7 @@ export interface operations { }; /** @description

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

*/ GetAccounts: { - parameters: { + parameters?: { query?: { created?: { gt?: number; @@ -18332,9 +18460,9 @@ export interface operations { full_name_aliases?: string[] | ""; /** @description The person's gender (International regulations require either "male" or "female"). */ gender?: string; - /** @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://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ + /** @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://stripe.com/docs/js/tokens/create_token?type=pii). */ id_number?: string; - /** @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://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ + /** @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://stripe.com/docs/js/tokens/create_token?type=pii). */ id_number_secondary?: string; /** @description The person's last name. */ last_name?: string; @@ -18535,9 +18663,9 @@ export interface operations { full_name_aliases?: string[] | ""; /** @description The person's gender (International regulations require either "male" or "female"). */ gender?: string; - /** @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://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ + /** @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://stripe.com/docs/js/tokens/create_token?type=pii). */ id_number?: string; - /** @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://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ + /** @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://stripe.com/docs/js/tokens/create_token?type=pii). */ id_number_secondary?: string; /** @description The person's last name. */ last_name?: string; @@ -18788,9 +18916,9 @@ export interface operations { full_name_aliases?: string[] | ""; /** @description The person's gender (International regulations require either "male" or "female"). */ gender?: string; - /** @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://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ + /** @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://stripe.com/docs/js/tokens/create_token?type=pii). */ id_number?: string; - /** @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://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ + /** @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://stripe.com/docs/js/tokens/create_token?type=pii). */ id_number_secondary?: string; /** @description The person's last name. */ last_name?: string; @@ -18991,9 +19119,9 @@ export interface operations { full_name_aliases?: string[] | ""; /** @description The person's gender (International regulations require either "male" or "female"). */ gender?: string; - /** @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://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ + /** @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://stripe.com/docs/js/tokens/create_token?type=pii). */ id_number?: string; - /** @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://stripe.com/docs/js/tokens_sources/create_token?type=pii). */ + /** @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://stripe.com/docs/js/tokens/create_token?type=pii). */ id_number_secondary?: string; /** @description The person's last name. */ last_name?: string; @@ -19141,7 +19269,7 @@ export interface operations { }; /** @description

List apple pay domains.

*/ GetApplePayDomains: { - parameters: { + parameters?: { query?: { domain_name?: string; /** @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. */ @@ -19271,7 +19399,7 @@ export interface operations { }; /** @description

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.

*/ GetApplicationFees: { - parameters: { + parameters?: { query?: { /** @description Only return application fees for the charge specified by this charge ID. */ charge?: string; @@ -19721,7 +19849,7 @@ export interface operations { * For a sample request, see Accounting for negative balances.

*/ GetBalance: { - parameters: { + parameters?: { query?: { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -19753,7 +19881,7 @@ export interface operations { *

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

*/ GetBalanceHistory: { - parameters: { + parameters?: { query?: { created?: { gt?: number; @@ -19851,7 +19979,7 @@ export interface operations { *

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

*/ GetBalanceTransactions: { - parameters: { + parameters?: { query?: { created?: { gt?: number; @@ -19945,7 +20073,7 @@ export interface operations { }; /** @description

Returns a list of configurations that describe the functionality of the customer portal.

*/ GetBillingPortalConfigurations: { - parameters: { + parameters?: { query?: { /** @description Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations). */ active?: boolean; @@ -20309,7 +20437,7 @@ export interface operations { }; /** @description

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

*/ GetCharges: { - parameters: { + parameters?: { query?: { created?: { gt?: number; @@ -21038,7 +21166,7 @@ export interface operations { }; /** @description

Returns a list of Checkout Sessions.

*/ GetCheckoutSessions: { - parameters: { + parameters?: { query?: { /** @description Only return the Checkout Sessions for the Customer specified. */ customer?: string; @@ -21184,6 +21312,9 @@ export interface operations { submit?: { message: string; } | ""; + terms_of_service_acceptance?: { + message: string; + } | ""; }; /** * @description ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recent card @@ -21378,6 +21509,8 @@ export interface operations { * @enum {string} */ payment_method_collection?: "always" | "if_required"; + /** @description The ID of the payment method configuration to use with this Checkout session. */ + payment_method_configuration?: string; /** * payment_method_options_param * @description Payment-method-specific configuration. @@ -21849,7 +21982,7 @@ export interface operations { }; /** @description

Lists all Country Spec objects available in the API.

*/ GetCountrySpecs: { - parameters: { + parameters?: { query?: { /** @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. */ ending_before?: string; @@ -21925,7 +22058,7 @@ export interface operations { }; /** @description

Returns a list of your coupons.

*/ GetCoupons: { - parameters: { + parameters?: { query?: { /** @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. */ created?: { @@ -22147,7 +22280,7 @@ export interface operations { }; /** @description

Returns a list of credit notes.

*/ GetCreditNotes: { - parameters: { + parameters?: { query?: { /** @description Only return credit notes for the customer specified by this customer ID. */ customer?: string; @@ -22582,7 +22715,7 @@ export interface operations { }; /** @description

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

*/ GetCustomers: { - parameters: { + parameters?: { query?: { created?: { gt?: number; @@ -25212,7 +25345,7 @@ export interface operations { }; /** @description

Returns a list of your disputes.

*/ GetDisputes: { - parameters: { + parameters?: { query?: { /** @description Only return disputes associated to the charge specified by this charge ID. */ charge?: string; @@ -25468,7 +25601,7 @@ export interface operations { }; /** @description

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

*/ GetEvents: { - parameters: { + parameters?: { query?: { created?: { gt?: number; @@ -25556,7 +25689,7 @@ export interface operations { }; /** @description

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.

*/ GetExchangeRates: { - parameters: { + parameters?: { query?: { /** @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. */ ending_before?: string; @@ -25632,7 +25765,7 @@ export interface operations { }; /** @description

Returns a list of file links.

*/ GetFileLinks: { - parameters: { + parameters?: { query?: { created?: { gt?: number; @@ -25644,7 +25777,7 @@ export interface operations { ending_before?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description Filter links by their expiration status. By default, all links are returned. */ + /** @description Filter links by their expiration status. By default, Stripe returns all links. */ expired?: boolean; /** @description Only return links for the given file. */ file?: string; @@ -25695,7 +25828,7 @@ export interface operations { expand?: string[]; /** * Format: unix-time - * @description A future timestamp after which the link will no longer be usable. + * @description The link isn't usable after this future timestamp. */ expires_at?: number; /** @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`, `identity_document_downloadable`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`. */ @@ -25789,9 +25922,9 @@ export interface operations { }; }; }; - /** @description

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

*/ + /** @description

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.

*/ GetFiles: { - parameters: { + parameters?: { query?: { created?: { gt?: number; @@ -25805,7 +25938,7 @@ export interface operations { expand?: string[]; /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ limit?: number; - /** @description The file purpose to filter queries by. If none is provided, files will not be filtered by purpose. */ + /** @description Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files. */ purpose?: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "document_provider_identity_document" | "finance_report_run" | "identity_document" | "identity_document_downloadable" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; /** @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. */ starting_after?: string; @@ -25843,9 +25976,9 @@ export interface operations { }; }; /** - * @description

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

+ * @description

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

* - *

All of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.

+ *

All of Stripe’s officially supported Client libraries support sending multipart/form-data.

*/ PostFiles: { requestBody: { @@ -25855,12 +25988,12 @@ export interface operations { expand?: string[]; /** * Format: binary - * @description A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the `multipart/form-data` protocol). + * @description A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol. */ file: string; /** * file_link_creation_params - * @description Optional parameters to automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file. + * @description Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file. */ file_link_data?: { create: boolean; @@ -25893,7 +26026,7 @@ export interface operations { }; }; }; - /** @description

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

*/ + /** @description

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

*/ GetFilesFile: { parameters: { query?: { @@ -25926,7 +26059,7 @@ export interface operations { }; /** @description

Returns a list of Financial Connections Account objects.

*/ GetFinancialConnectionsAccounts: { - parameters: { + parameters?: { query?: { /** @description If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive. */ account_holder?: { @@ -26206,7 +26339,7 @@ export interface operations { }; /** @description

List all verification reports.

*/ GetIdentityVerificationReports: { - parameters: { + parameters?: { query?: { created?: { gt?: number; @@ -26292,7 +26425,7 @@ export interface operations { }; /** @description

Returns a list of VerificationSessions

*/ GetIdentityVerificationSessions: { - parameters: { + parameters?: { query?: { created?: { gt?: number; @@ -26577,7 +26710,7 @@ export interface operations { }; /** @description

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

*/ GetInvoiceitems: { - parameters: { + parameters?: { query?: { created?: { gt?: number; @@ -26871,7 +27004,7 @@ export interface operations { }; /** @description

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.

*/ GetInvoices: { - parameters: { + parameters?: { query?: { /** @description The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. */ collection_method?: "charge_automatically" | "send_invoice"; @@ -27075,6 +27208,19 @@ export interface operations { * @enum {string} */ pending_invoice_items_behavior?: "exclude" | "include" | "include_and_require"; + /** + * rendering_param + * @description The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. + */ + rendering?: { + /** @enum {string} */ + amount_tax_display?: "" | "exclude_tax" | "include_inclusive_tax"; + /** rendering_pdf_param */ + pdf?: { + /** @enum {string} */ + page_size?: "a4" | "auto" | "letter"; + }; + }; /** @description Options for invoice PDF rendering. */ rendering_options?: ({ /** @enum {string} */ @@ -27232,7 +27378,7 @@ export interface operations { *

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 a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

*/ GetInvoicesUpcoming: { - parameters: { + parameters?: { query?: { /** @description Settings for automatic tax lookup for this invoice preview. */ automatic_tax?: { @@ -27408,7 +27554,7 @@ export interface operations { }; /** @description

When retrieving an upcoming invoice, you’ll get a lines 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.

*/ GetInvoicesUpcomingLines: { - parameters: { + parameters?: { query?: { /** @description Settings for automatic tax lookup for this invoice preview. */ automatic_tax?: { @@ -27763,6 +27909,19 @@ export interface operations { }; payment_method_types?: (("ach_credit_transfer" | "ach_debit" | "acss_debit" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "paynow" | "paypal" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[]) | ""; }; + /** + * rendering_param + * @description The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. + */ + rendering?: { + /** @enum {string} */ + amount_tax_display?: "" | "exclude_tax" | "include_inclusive_tax"; + /** rendering_pdf_param */ + pdf?: { + /** @enum {string} */ + page_size?: "a4" | "auto" | "letter"; + }; + }; /** @description Options for invoice PDF rendering. */ rendering_options?: ({ /** @enum {string} */ @@ -28100,7 +28259,7 @@ export interface operations { }; /** @description

Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetIssuingAuthorizations: { - parameters: { + parameters?: { query?: { /** @description Only return authorizations that belong to the given card. */ card?: string; @@ -28222,8 +28381,8 @@ export interface operations { }; }; /** - * @description

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. - * You can also respond directly to the webhook request to approve an authorization (preferred). More details can be found here.

+ * @description

[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. + * This method is deprecated. Instead, respond directly to the webhook request to approve an authorization.

*/ PostIssuingAuthorizationsAuthorizationApprove: { parameters: { @@ -28261,8 +28420,8 @@ export interface operations { }; }; /** - * @description

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow. - * You can also respond directly to the webhook request to decline an authorization (preferred). More details can be found here.

+ * @description

[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow. + * This method is deprecated. Instead, respond directly to the webhook request to decline an authorization.

*/ PostIssuingAuthorizationsAuthorizationDecline: { parameters: { @@ -28299,7 +28458,7 @@ export interface operations { }; /** @description

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetIssuingCardholders: { - parameters: { + parameters?: { query?: { /** @description Only return cardholders that were created during the given date interval. */ created?: { @@ -28626,7 +28785,7 @@ export interface operations { }; /** @description

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetIssuingCards: { - parameters: { + parameters?: { query?: { /** @description Only return cards belonging to the Cardholder with the provided ID. */ cardholder?: string; @@ -28877,7 +29036,7 @@ export interface operations { }; /** @description

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetIssuingDisputes: { - parameters: { + parameters?: { query?: { /** @description Select Issuing disputes that were created during the given date interval. */ created?: { @@ -29204,7 +29363,7 @@ export interface operations { }; /** @description

Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetIssuingSettlements: { - parameters: { + parameters?: { query?: { /** @description Only return issuing settlements that were created during the given date interval. */ created?: { @@ -29321,7 +29480,7 @@ export interface operations { }; /** @description

Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetIssuingTransactions: { - parameters: { + parameters?: { query?: { /** @description Only return transactions that belong to the given card. */ card?: string; @@ -29527,7 +29686,7 @@ export interface operations { }; /** @description

Returns a list of Financial Connections Account objects.

*/ GetLinkedAccounts: { - parameters: { + parameters?: { query?: { /** @description If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive. */ account_holder?: { @@ -29755,7 +29914,7 @@ export interface operations { }; /** @description

Returns a list of PaymentIntents.

*/ GetPaymentIntents: { - parameters: { + parameters?: { query?: { /** @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. */ created?: { @@ -29894,6 +30053,8 @@ export interface operations { * If this parameter is omitted with `confirm=true`, `customer.default_source` will be attached as this PaymentIntent's payment instrument to improve the migration experience for users of the Charges API. We recommend that you explicitly provide the `payment_method` going forward. */ payment_method?: string; + /** @description The ID of the payment method configuration to use with this PaymentIntent. */ + payment_method_configuration?: string; /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -30446,10 +30607,10 @@ export interface operations { /** * @description

Updates properties on a PaymentIntent object without confirming.

* - *

Depending on which properties you update, you may need to confirm the - * PaymentIntent again. For example, updating the payment_method will - * always require you to confirm the PaymentIntent again. If you prefer to - * update and confirm at the same time, we recommend updating properties via + *

Depending on which properties you update, you might need to confirm the + * PaymentIntent again. For example, updating the payment_method + * always requires you to confirm the PaymentIntent again. If you prefer to + * update and confirm at the same time, we recommend updating properties through * the confirm API instead.

*/ PostPaymentIntentsIntent: { @@ -30490,6 +30651,8 @@ export interface operations { } | ""; /** @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. */ payment_method?: string; + /** @description The ID of the payment method configuration to use with this PaymentIntent. */ + payment_method_configuration?: string; /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -30873,7 +31036,7 @@ export interface operations { setup_future_usage?: "none"; } | ""; }; - /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. Use automatic_payment_methods to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). */ + /** @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). */ payment_method_types?: 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). */ receipt_email?: string | ""; @@ -30910,12 +31073,12 @@ export interface operations { statement_descriptor_suffix?: string; /** * transfer_data_update_params - * @description The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + * @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). */ transfer_data?: { amount?: number; }; - /** @description A string that identifies the resulting payment as part of a group. `transfer_group` may only be provided if it has not been set. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ + /** @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). */ transfer_group?: string; }; }; @@ -31713,7 +31876,7 @@ export interface operations { }; /** @description

Returns a list of your payment links.

*/ GetPaymentLinks: { - parameters: { + parameters?: { query?: { /** @description Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links). */ active?: boolean; @@ -31850,6 +32013,9 @@ export interface operations { submit?: { message: string; } | ""; + terms_of_service_acceptance?: { + message: string; + } | ""; }; /** * @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). @@ -32100,6 +32266,9 @@ export interface operations { submit?: { message: string; } | ""; + terms_of_service_acceptance?: { + message: string; + } | ""; }; /** * @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). @@ -32229,9 +32398,870 @@ export interface operations { }; }; }; + /** @description

List payment method configurations

*/ + GetPaymentMethodConfigurations: { + parameters?: { + query?: { + /** @description The Connect application to filter by. */ + application?: string | ""; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + content: { + "application/json": { + data: components["schemas"]["payment_method_configuration"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + /** @description

Creates a payment method configuration

*/ + PostPaymentMethodConfigurations: { + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** + * payment_method_param + * @description Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability. + */ + acss_debit?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + affirm?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + afterpay_clearpay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + alipay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + apple_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + apple_pay_later?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + au_becs_debit?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + bacs_debit?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + bancontact?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + blik?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + boleto?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks. + */ + card?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + cartes_bancaires?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + cashapp?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + eps?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * payment_method_param + * @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. + */ + fpx?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + giropay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + google_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + grabpay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + ideal?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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 the US, Canada, Australia, New Zealand, UK, and Ireland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. + */ + jcb?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + klarna?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + konbini?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + link?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** @description Configuration name. */ + name?: string; + /** + * payment_method_param + * @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. + */ + oxxo?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + p24?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** @description Configuration's parent configuration. Specify to create a child configuration. */ + parent?: string; + /** + * payment_method_param + * @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. + */ + paynow?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + paypal?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + promptpay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + sepa_debit?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + sofort?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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-debit) for more details. + */ + us_bank_account?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + wechat_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + content: { + "application/json": components["schemas"]["payment_method_configuration"]; + }; + }; + /** @description Error response. */ + default: { + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + /** @description

Retrieve payment method configuration

*/ + GetPaymentMethodConfigurationsConfiguration: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + path: { + configuration: string; + }; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + content: { + "application/json": components["schemas"]["payment_method_configuration"]; + }; + }; + /** @description Error response. */ + default: { + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + /** @description

Update payment method configuration

*/ + PostPaymentMethodConfigurationsConfiguration: { + parameters: { + path: { + configuration: string; + }; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** + * payment_method_param + * @description Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability. + */ + acss_debit?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** @description Whether the configuration can be used for new payments. */ + active?: boolean; + /** + * payment_method_param + * @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. + */ + affirm?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + afterpay_clearpay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + alipay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + apple_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + apple_pay_later?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + au_becs_debit?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + bacs_debit?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + bancontact?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + blik?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + boleto?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks. + */ + card?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + cartes_bancaires?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + cashapp?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + eps?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * payment_method_param + * @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. + */ + fpx?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + giropay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + google_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + grabpay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + ideal?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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 the US, Canada, Australia, New Zealand, UK, and Ireland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. + */ + jcb?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + klarna?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + konbini?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + link?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** @description Configuration name. */ + name?: string; + /** + * payment_method_param + * @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. + */ + oxxo?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + p24?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + paynow?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + paypal?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + promptpay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + sepa_debit?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + sofort?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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-debit) for more details. + */ + us_bank_account?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @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. + */ + wechat_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + content: { + "application/json": components["schemas"]["payment_method_configuration"]; + }; + }; + /** @description Error response. */ + default: { + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; /** @description

Lists the details of existing payment method domains.

*/ GetPaymentMethodDomains: { - parameters: { + parameters?: { query?: { /** @description The domain name that this payment method domain object represents. */ domain_name?: string; @@ -32409,7 +33439,7 @@ export interface operations { }; /** @description

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 List a Customer’s PaymentMethods API instead.

*/ GetPaymentMethods: { - parameters: { + parameters?: { query?: { /** @description The ID of the customer whose PaymentMethods will be retrieved. */ customer?: string; @@ -32911,7 +33941,7 @@ export interface operations { }; /** @description

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

*/ GetPayouts: { - parameters: { + parameters?: { query?: { arrival_date?: { gt?: number; @@ -33160,7 +34190,7 @@ export interface operations { }; /** @description

Returns a list of your plans.

*/ GetPlans: { - parameters: { + parameters?: { query?: { /** @description Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans). */ active?: boolean; @@ -33420,7 +34450,7 @@ export interface operations { }; /** @description

Returns a list of your prices.

*/ GetPrices: { - parameters: { + parameters?: { query?: { /** @description Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices). */ active?: boolean; @@ -33791,7 +34821,7 @@ export interface operations { }; /** @description

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

*/ GetProducts: { - parameters: { + parameters?: { query?: { /** @description Only return products that are active or inactive (e.g., pass `false` to list all inactive products). */ active?: boolean; @@ -34142,7 +35172,7 @@ export interface operations { }; /** @description

Returns a list of your promotion codes.

*/ GetPromotionCodes: { - parameters: { + parameters?: { query?: { /** @description Filter promotion codes by whether they are active. */ active?: boolean; @@ -34338,7 +35368,7 @@ export interface operations { }; /** @description

Returns a list of your quotes.

*/ GetQuotes: { - parameters: { + parameters?: { query?: { /** @description The ID of the customer whose quotes will be retrieved. */ customer?: string; @@ -34882,7 +35912,7 @@ export interface operations { }; /** @description

Returns a list of early fraud warnings.

*/ GetRadarEarlyFraudWarnings: { - parameters: { + parameters?: { query?: { /** @description Only return early fraud warnings for the charge specified by this charge ID. */ charge?: string; @@ -35108,7 +36138,7 @@ export interface operations { }; /** @description

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetRadarValueLists: { - parameters: { + parameters?: { query?: { /** @description The alias used to reference the value list when writing rules. */ alias?: string; @@ -35297,7 +36327,7 @@ export interface operations { }; /** @description

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

*/ GetRefunds: { - parameters: { + parameters?: { query?: { /** @description Only return refunds for the charge specified by this charge ID. */ charge?: string; @@ -35503,7 +36533,7 @@ export interface operations { }; /** @description

Returns a list of Report Runs, with the most recent appearing first.

*/ GetReportingReportRuns: { - parameters: { + parameters?: { query?: { created?: { gt?: number; @@ -35630,7 +36660,7 @@ export interface operations { }; /** @description

Returns a full list of Report Types.

*/ GetReportingReportTypes: { - parameters: { + parameters?: { query?: { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -35700,7 +36730,7 @@ export interface operations { }; /** @description

Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ GetReviews: { - parameters: { + parameters?: { query?: { created?: { gt?: number; @@ -35810,13 +36840,13 @@ export interface operations { }; }; }; - /** @description

Returns a list of SetupAttempts associated with a provided SetupIntent.

*/ + /** @description

Returns a list of SetupAttempts that associate with a provided SetupIntent.

*/ GetSetupAttempts: { parameters: { query: { /** * @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 + * can be a string with an integer Unix timestamp or a * dictionary with a number of different query options. */ created?: { @@ -35873,7 +36903,7 @@ export interface operations { }; /** @description

Returns a list of SetupIntents.

*/ GetSetupIntents: { - parameters: { + parameters?: { query?: { /** * @description If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. @@ -36001,6 +37031,8 @@ export interface operations { on_behalf_of?: string; /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ payment_method?: string; + /** @description The ID of the payment method configuration to use with this Setup Intent. */ + payment_method_configuration?: string; /** * payment_method_data_params * @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) @@ -36324,6 +37356,8 @@ export interface operations { } | ""; /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ payment_method?: string; + /** @description The ID of the payment method configuration to use with this SetupIntent. */ + payment_method_configuration?: string; /** * payment_method_data_params * @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) @@ -36924,7 +37958,7 @@ export interface operations { }; /** @description

Returns a list of your shipping rates.

*/ GetShippingRates: { - parameters: { + parameters?: { query?: { /** @description Only return shipping rates that are active or inactive. */ active?: boolean; @@ -37141,7 +38175,7 @@ export interface operations { }; /** @description

Returns a list of scheduled query runs.

*/ GetSigmaScheduledQueryRuns: { - parameters: { + parameters?: { query?: { /** @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. */ ending_before?: string; @@ -38048,7 +39082,7 @@ export interface operations { }; /** @description

Retrieves the list of your subscription schedules.

*/ GetSubscriptionSchedules: { - parameters: { + parameters?: { query?: { /** @description Only return subscription schedules that were created canceled the given date interval. */ canceled_at?: { @@ -38532,7 +39566,7 @@ export interface operations { }; /** @description

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

*/ GetSubscriptions: { - parameters: { + parameters?: { query?: { /** @description Filter subscriptions by their automatic tax settings. */ automatic_tax?: { @@ -39436,7 +40470,7 @@ export interface operations { }; /** @description

Retrieves Tax Settings for a merchant.

*/ GetTaxSettings: { - parameters: { + parameters?: { query?: { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -39685,7 +40719,7 @@ export interface operations { }; /** @description

A list of all tax codes available to add to Products in order to allow specific tax calculations.

*/ GetTaxCodes: { - parameters: { + parameters?: { query?: { /** @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. */ ending_before?: string; @@ -39761,7 +40795,7 @@ export interface operations { }; /** @description

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

*/ GetTaxRates: { - parameters: { + parameters?: { query?: { /** @description Optional flag to filter by tax rates that are either active or inactive (archived). */ active?: boolean; @@ -39949,7 +40983,7 @@ export interface operations { }; /** @description

Returns a list of Configuration objects.

*/ GetTerminalConfigurations: { - parameters: { + parameters?: { query?: { /** @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. */ ending_before?: string; @@ -40332,7 +41366,7 @@ export interface operations { }; /** @description

Returns a list of Location objects.

*/ GetTerminalLocations: { - parameters: { + parameters?: { query?: { /** @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. */ ending_before?: string; @@ -40533,7 +41567,7 @@ export interface operations { }; /** @description

Returns a list of Reader objects.

*/ GetTerminalReaders: { - parameters: { + parameters?: { query?: { /** @description Filters readers by device type */ device_type?: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "simulated_wisepos_e" | "stripe_m2" | "verifone_P400"; @@ -41640,7 +42674,7 @@ export interface operations { }; /** @description

Returns a list of your test clocks.

*/ GetTestHelpersTestClocks: { - parameters: { + parameters?: { query?: { /** @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. */ ending_before?: string; @@ -42568,7 +43602,7 @@ export interface operations { }; /** @description

Returns a list of top-ups.

*/ GetTopups: { - parameters: { + parameters?: { query?: { /** @description A positive integer representing how much to transfer. */ amount?: { @@ -42767,7 +43801,7 @@ export interface operations { }; /** @description

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.

*/ GetTransfers: { - parameters: { + parameters?: { query?: { created?: { gt?: number; @@ -43336,7 +44370,7 @@ export interface operations { }; /** @description

Returns a list of FinancialAccounts.

*/ GetTreasuryFinancialAccounts: { - parameters: { + parameters?: { query?: { created?: { gt?: number; @@ -44625,7 +45659,7 @@ export interface operations { }; /** @description

Returns a list of your webhook endpoints.

*/ GetWebhookEndpoints: { - parameters: { + parameters?: { query?: { /** @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. */ ending_before?: string; @@ -44683,7 +45717,7 @@ export interface operations { /** @description An optional description of what the webhook is used for. */ description?: string | ""; /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ - enabled_events: ("*" | "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_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" | "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" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "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.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "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.submitted" | "issuing_dispute.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "order.created" | "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" | "recipient.created" | "recipient.deleted" | "recipient.updated" | "refund.created" | "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" | "sku.created" | "sku.deleted" | "sku.updated" | "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_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.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; + enabled_events: ("*" | "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_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" | "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" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "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.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "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.submitted" | "issuing_dispute.updated" | "issuing_transaction.created" | "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.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_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.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; /** @description Specifies which fields in the response should be expanded. */ expand?: 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`. */ @@ -44756,7 +45790,7 @@ export interface operations { /** @description Disable the webhook endpoint if set to true. */ disabled?: boolean; /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ - enabled_events?: ("*" | "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_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" | "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" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "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.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "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.submitted" | "issuing_dispute.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "order.created" | "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" | "recipient.created" | "recipient.deleted" | "recipient.updated" | "refund.created" | "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" | "sku.created" | "sku.deleted" | "sku.updated" | "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_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.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; + enabled_events?: ("*" | "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_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" | "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" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "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.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "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.submitted" | "issuing_dispute.updated" | "issuing_transaction.created" | "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.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_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.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; /** @description Specifies which fields in the response should be expanded. */ expand?: 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`. */ diff --git a/packages/openapi-typescript/examples/stripe-api.yaml b/packages/openapi-typescript/examples/stripe-api.yaml index d391d1a2a..ed33a230c 100644 --- a/packages/openapi-typescript/examples/stripe-api.yaml +++ b/packages/openapi-typescript/examples/stripe-api.yaml @@ -2112,19 +2112,19 @@ components: description: >- Balance transactions represent funds moving through your Stripe account. - They're created for every type of transaction that comes into or flows - out of your Stripe account balance. + Stripe creates them for every type of transaction that enters or leaves + your Stripe account balance. Related guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types) properties: amount: - description: 'Gross amount of the transaction, in cents (or local equivalent).' + description: Gross amount of the transaction (in cents (or local equivalent)). type: integer available_on: description: >- - The date the transaction's net funds will become available in the + The date that the transaction's net funds become available in the Stripe balance. format: unix-time type: integer @@ -2150,15 +2150,14 @@ components: type: string exchange_rate: description: >- - The exchange rate used, if applicable, for this transaction. - Specifically, if money was converted from currency A to currency B, - then the `amount` in currency A, times `exchange_rate`, would be the - `amount` in currency B. For example, suppose you charged a customer - 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and - `currency` would be `eur`. Suppose this was converted into 12.34 USD - in your Stripe account. Then the BalanceTransaction's `amount` would - be `1234`, `currency` would be `usd`, and `exchange_rate` would be - `1.234`. + 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: @@ -2176,7 +2175,7 @@ components: maxLength: 5000 type: string net: - description: 'Net amount of the transaction, in cents (or local equivalent).' + description: Net amount of the transaction (in cents (or local equivalent)). type: integer object: description: >- @@ -2187,9 +2186,9 @@ components: type: string reporting_category: description: >- - [Learn more](https://stripe.com/docs/reports/reporting-categories) - about how reporting categories can help you understand balance - transactions from an accounting perspective. + 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: @@ -2213,7 +2212,7 @@ components: - $ref: '#/components/schemas/topup' - $ref: '#/components/schemas/transfer' - $ref: '#/components/schemas/transfer_reversal' - description: The Stripe object to which this transaction is related. + description: This transaction relates to the Stripe object. nullable: true x-expansionResources: oneOf: @@ -2237,8 +2236,8 @@ components: x-stripeBypassValidation: true status: description: >- - If the transaction's net funds are available in the Stripe balance - yet. Either `available` or `pending`. + The transaction's net funds status in the Stripe balance, which are + either `available` or `pending`. maxLength: 5000 type: string type: @@ -2256,11 +2255,11 @@ components: `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](https://stripe.com/docs/reports/balance-transaction-types) - about balance transaction types and what they represent. If you are - looking to classify transactions for accounting purposes, you might - want to consider `reporting_category` instead. + `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 @@ -4324,6 +4323,14 @@ components: - 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' @@ -4497,6 +4504,7 @@ components: - line_items - payment_intent - payment_link + - payment_method_configuration_details - payment_method_options - phone_number_collection - setup_intent @@ -5559,14 +5567,14 @@ components: description: '' properties: account_onboarding: - $ref: '#/components/schemas/connect_embedded_base_config' + $ref: '#/components/schemas/connect_embedded_base_config_claim' required: - account_onboarding title: ConnectEmbeddedAccountSessionCreateComponents type: object x-expandableFields: - account_onboarding - connect_embedded_base_config: + connect_embedded_base_config_claim: description: '' properties: enabled: @@ -5574,7 +5582,7 @@ components: type: boolean required: - enabled - title: ConnectEmbeddedBaseConfig + title: ConnectEmbeddedBaseConfigClaim type: object x-expandableFields: [] country_spec: @@ -6371,7 +6379,7 @@ components: x-expandableFields: [] customer: description: >- - This object represents a customer of your business. It lets you create + This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer. @@ -6385,22 +6393,22 @@ components: nullable: true balance: description: >- - Current balance, if any, being 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 will be added to their next - invoice. The balance does not refer to any unpaid invoices; it - solely takes into account amounts that have yet to be successfully - applied to any invoice. This balance is only taken into account as - invoices are finalized. + 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. - These funds can be applied towards payment intents with source - "cash_balance". The settings[reconciliation_mode] field describes - whether these funds are applied to such payment intents manually or + 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: @@ -6428,7 +6436,7 @@ components: ID of the default payment source for the customer. - If you are using payment methods created via the PaymentMethods API, + If 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. @@ -6441,16 +6449,15 @@ components: x-stripeBypassValidation: true delinquent: description: >- - When the customer's latest invoice is billed by charging - automatically, `delinquent` is `true` if the invoice's latest charge - failed. When the customer's latest invoice is billed by sending an - invoice, `delinquent` is `true` if the invoice isn't paid by its due - date. + If Stripe bills the customer's latest invoice by automatically + charging and the latest charge fails, it sets `delinquent`` to + `true``. If Stripe bills the invoice by sending it, and the invoice + isn't paid by the due date, it also sets `delinquent`` to `true`. - If an invoice is marked uncollectible by + If an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), - `delinquent` doesn't get reset to `false`. + `delinquent` doesn't reset to `false`. nullable: true type: boolean description: @@ -6480,15 +6487,15 @@ components: additionalProperties: type: integer description: >- - The current multi-currency balances, if any, being stored on the + 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 will be added to - their next invoice denominated in that currency. These balances do - not refer to any unpaid invoices. They solely track amounts that - have yet to be successfully applied to any invoice. A balance in a - particular currency is only applied to any invoice as an invoice in - that currency is finalized. + 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. @@ -6517,7 +6524,9 @@ components: nullable: true type: string next_invoice_sequence: - description: 'The suffix of the customer''s next invoice number, e.g., 0001.' + description: >- + The suffix of the customer's next invoice number (for example, + 0001). type: integer object: description: >- @@ -6620,9 +6629,9 @@ components: $ref: '#/components/schemas/customer_tax' tax_exempt: description: >- - Describes the customer's tax exemption status. One of `none`, + Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt - PDFs include the text **"Reverse charge"**. + PDFs include the following text: **"Reverse charge"**. enum: - exempt - none @@ -6667,7 +6676,7 @@ components: - maxLength: 5000 type: string - $ref: '#/components/schemas/test_helpers.test_clock' - description: ID of the test clock this customer belongs to. + description: ID of the test clock that this customer belongs to. nullable: true x-expansionResources: oneOf: @@ -6696,7 +6705,7 @@ components: description: '' properties: accepted_at: - description: The time at which the customer accepted the Mandate. + description: The time that the customer accepts the mandate. format: unix-time nullable: true type: integer @@ -6706,8 +6715,8 @@ components: $ref: '#/components/schemas/online_acceptance' type: description: >- - The type of customer acceptance information included with the - Mandate. One of `online` or `offline`. + The mandate includes the type of customer acceptance information, + such as: `online` or `offline`. enum: - offline - online @@ -8160,21 +8169,17 @@ components: A dispute occurs when a customer questions your charge with their card issuer. - When this happens, you're given the opportunity to respond to the - dispute with - - evidence that shows that the charge is legitimate. You can find more - - information about the dispute process in our [Disputes and + When this happens, you have the opportunity to respond to the dispute + with - Fraud](/docs/disputes) documentation. + evidence that shows that the charge is legitimate. Related guide: [Disputes and fraud](https://stripe.com/docs/disputes) properties: amount: description: >- - Disputed amount. Usually the amount of the charge, but can differ + 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 @@ -8191,7 +8196,7 @@ components: - maxLength: 5000 type: string - $ref: '#/components/schemas/charge' - description: ID of the charge that was disputed. + description: ID of the charge that's disputed. x-expansionResources: oneOf: - $ref: '#/components/schemas/charge' @@ -8218,9 +8223,9 @@ components: type: string is_charge_refundable: description: >- - If true, it is still possible to refund the disputed payment. Once - the payment has been fully refunded, no further funds will be - withdrawn from your Stripe account as a result of this dispute. + 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: >- @@ -8248,7 +8253,7 @@ components: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_intent' - description: ID of the PaymentIntent that was disputed. + description: ID of the PaymentIntent that's disputed. nullable: true x-expansionResources: oneOf: @@ -8263,7 +8268,7 @@ components: `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. - Read more about [dispute + Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories). maxLength: 5000 type: string @@ -8714,29 +8719,26 @@ components: object. For example, when a charge succeeds, we create a `charge.succeeded` - event; and when an invoice payment attempt fails, we create an + event, and when an invoice payment attempt fails, we create an - `invoice.payment_failed` event. Note that many API requests may cause + `invoice.payment_failed` event. Certain API requests might create multiple - events to be created. For example, if you create a new subscription for - a + events. For example, if you create a new subscription for a - customer, you will receive both a `customer.subscription.created` event - and a + customer, you receive both a `customer.subscription.created` event and a `charge.succeeded` event. - Events occur when the state of another API resource changes. The state - of that + Events occur when the state of another API resource changes. The event's + data - resource at the time of the change is embedded in the event's data - field. For + field embeds the resource's state at the time of the change. For - example, a `charge.succeeded` event will contain a charge, and an + example, a `charge.succeeded` event contains a charge, and an - `invoice.payment_failed` event will contain an invoice. + `invoice.payment_failed` event contains an invoice. As with other API resources, you can use endpoints to retrieve an @@ -8748,39 +8750,40 @@ components: [webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the - `Event` objects directly to an endpoint on your server. Webhooks are - managed + `Event` objects directly to an endpoint on your server. You can manage - in your + webhooks in your - [account settings](https://dashboard.stripe.com/account/webhooks), + [account settings](https://dashboard.stripe.com/account/webhooks). Learn + how - and our [Using Webhooks](https://stripe.com/docs/webhooks) guide will - help you get set up. + to [listen for events] + + (/docs/webhooks) so that your integration can automatically trigger + reactions. When using [Connect](https://stripe.com/docs/connect), you can also - receive notifications of + receive event notifications - events that occur in connected accounts. For these events, there will be - an + that occur in connected accounts. For these events, there's an additional `account` attribute in the received `Event` object. - **NOTE:** Right now, access to events through the [Retrieve Event - API](https://stripe.com/docs/api#retrieve_event) is + We only guarantee access to events through the [Retrieve Event + API](https://stripe.com/docs/api#retrieve_event) - guaranteed only for 30 days. + for 30 days. properties: account: - description: The connected account that originated the event. + description: The connected account that originates the event. maxLength: 5000 type: string api_version: description: >- - The Stripe API version used to render `data`. *Note: This property - is populated only for events on or after October 31, 2014*. + 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 @@ -8810,17 +8813,17 @@ components: type: string pending_webhooks: description: >- - Number of webhooks that have yet to be successfully delivered (i.e., - to return a 20x response) to the URLs you've specified. + 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 instigated the event. + description: Information on the API request that triggers the event. nullable: true type: description: >- - Description of the event (e.g., `invoice.created` or + Description of the event (for example, `invoice.created` or `charge.refunded`). maxLength: 5000 type: string @@ -9074,14 +9077,15 @@ components: x-resourceId: fee_refund file: description: >- - This is an object representing a file hosted on Stripe's servers. The + This object represents files hosted on Stripe's servers. You can upload - file may have been uploaded by yourself using the [create - file](https://stripe.com/docs/api#create_file) + files with the [create file](https://stripe.com/docs/api#create_file) + request - request (for example, when uploading dispute evidence) or it may have + (for example, when uploading dispute evidence). Stripe also - been created by Stripe (for example, the results of a [Sigma scheduled + creates files independetly (for example, the results of a [Sigma + scheduled query](#scheduled_queries)). @@ -9095,14 +9099,12 @@ components: format: unix-time type: integer expires_at: - description: >- - The time at which the file expires and is no longer available in - epoch seconds. + description: The file expires and isn't available at this time in epoch seconds. format: unix-time nullable: true type: integer filename: - description: 'A filename for the file, suitable for saving to a filesystem.' + description: The suitable name for saving the file to a filesystem. maxLength: 5000 nullable: true type: string @@ -9177,22 +9179,20 @@ components: type: string x-stripeBypassValidation: true size: - description: The size in bytes of the file object. + description: The size of the file object in bytes. type: integer title: - description: A user friendly title for the document. + description: A suitable title for the document. maxLength: 5000 nullable: true type: string type: - description: 'The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`).' + description: 'The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).' maxLength: 5000 nullable: true type: string url: - description: >- - The URL from which the file can be downloaded using your live secret - API key. + description: Use your live secret API key to download the file from this URL. maxLength: 5000 nullable: true type: string @@ -9210,7 +9210,7 @@ components: file_link: description: |- To share the contents of a `File` object with non-Stripe users, you can - create a `FileLink`. `FileLink`s contain a URL that can be used to + create a `FileLink`. `FileLink`s contain a URL that you can use to retrieve the contents of the file without authentication. properties: created: @@ -9220,10 +9220,10 @@ components: format: unix-time type: integer expired: - description: Whether this link is already expired. + description: Returns if the link is already expired. type: boolean expires_at: - description: Time at which the link expires. + description: Time that the link expires. format: unix-time nullable: true type: integer @@ -11405,6 +11405,14 @@ components: maxLength: 5000 nullable: true type: string + rendering: + anyOf: + - $ref: '#/components/schemas/invoices_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 rendering_options: anyOf: - $ref: '#/components/schemas/invoice_setting_rendering_options' @@ -11598,6 +11606,7 @@ components: - payment_intent - payment_settings - quote + - rendering - rendering_options - shipping_cost - shipping_details @@ -11867,6 +11876,23 @@ components: title: invoice_payment_method_options_us_bank_account_linked_account_options 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_setting_custom_field: description: '' properties: @@ -12317,6 +12343,25 @@ components: type: object x-expandableFields: - invoice + invoices_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 + title: InvoicesInvoiceRendering + type: object + x-expandableFields: + - pdf invoices_payment_method_options: description: '' properties: @@ -14570,9 +14615,11 @@ components: type: string phone_number: description: >- - The phone number of the receiver of the bulk shipment. This phone - number will be provided to the shipping company, who might use it to - contact the receiver in case of delivery issues. + 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 @@ -17552,7 +17599,7 @@ components: x-resourceId: login_link mandate: description: >- - A Mandate is a record of the permission a customer has given you to + A Mandate is a record of the permission that your customer gives you to debit their payment method. properties: customer_acceptance: @@ -17576,7 +17623,7 @@ components: - mandate type: string on_behalf_of: - description: The account (if any) for which the mandate is intended. + description: The account (if any) that the mandate is intended for. maxLength: 5000 type: string payment_method: @@ -17594,7 +17641,7 @@ components: $ref: '#/components/schemas/mandate_single_use' status: description: >- - The status of the mandate, which indicates whether it can be used to + The mandate status indicates whether or not you can use it to initiate a payment. enum: - active @@ -17746,9 +17793,9 @@ components: $ref: '#/components/schemas/mandate_sepa_debit' type: description: >- - The type of the payment method associated with this mandate. An - additional hash is included on `payment_method_details` with a name - matching this value. It contains mandate information specific to the + 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 @@ -17813,10 +17860,10 @@ components: description: '' properties: amount: - description: 'On a single use mandate, the amount of the payment.' + description: The amount of the payment on a single use mandate. type: integer currency: - description: 'On a single use mandate, the currency of the payment.' + description: The currency of the payment on a single use mandate. type: string required: - amount @@ -17907,14 +17954,14 @@ components: description: '' properties: ip_address: - description: The IP address from which the Mandate was accepted by the customer. + description: The customer accepts the mandate from this IP address. maxLength: 5000 nullable: true type: string user_agent: description: >- - The user agent of the browser from which the Mandate was accepted by - the customer. + The customer accepts the mandate using the user agent of the + browser. maxLength: 5000 nullable: true type: string @@ -18505,6 +18552,14 @@ components: 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 used for this + PaymentIntent. + nullable: true payment_method_options: anyOf: - $ref: '#/components/schemas/payment_intent_payment_method_options' @@ -18649,6 +18704,7 @@ components: - next_action - on_behalf_of - payment_method + - payment_method_configuration_details - payment_method_options - processing - review @@ -20516,16 +20572,24 @@ components: 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: - shipping_address - submit + - terms_of_service_acceptance payment_links_resource_custom_text_position: description: '' properties: message: - description: Text may be up to 1000 characters in length. + description: Text may be up to 1200 characters in length. maxLength: 500 type: string required: @@ -21754,6 +21818,271 @@ components: 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 configurations, whether or not the account's preference + will be observed. If `false`, the parent configuration's preference + 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: An object detailing 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 + apple_pay: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties + application: + description: The Connect application associated with this 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 + 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 + id_bank_transfer: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties + ideal: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties + is_default: + description: >- + The default configuration is used whenever no payment method + configuration is 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 + multibanco: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties + name: + description: Configuration name. + maxLength: 5000 + type: string + netbanking: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties + 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: 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 + sepa_debit: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties + sofort: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties + upi: + $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 + required: + - active + - id + - is_default + - livemode + - name + - object + title: PaymentMethodConfigResourcePaymentMethodConfiguration + type: object + x-expandableFields: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - apple_pay + - au_becs_debit + - bacs_debit + - bancontact + - blik + - boleto + - card + - cartes_bancaires + - cashapp + - eps + - fpx + - giropay + - google_pay + - grabpay + - id_bank_transfer + - ideal + - jcb + - klarna + - konbini + - link + - multibanco + - netbanking + - oxxo + - p24 + - pay_by_bank + - paynow + - paypal + - promptpay + - sepa_debit + - sofort + - upi + - us_bank_account + - wechat_pay + x-resourceId: payment_method_configuration payment_method_customer_balance: description: '' properties: {} @@ -25656,16 +25985,25 @@ components: 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: - shipping_address - submit + - terms_of_service_acceptance payment_pages_checkout_session_custom_text_position: description: '' properties: message: - description: Text may be up to 1000 characters in length. + description: Text may be up to 1200 characters in length. maxLength: 500 type: string required: @@ -26593,7 +26931,7 @@ components: Related guide: [Handling identity verification with the - API](https://stripe.com/docs/connect/identity-verification-api#person-information) + API](https://stripe.com/docs/connect/handling-api-verification#person-information) properties: account: description: The account the person is associated with. @@ -30034,7 +30372,7 @@ components: setup_attempt: description: |- A SetupAttempt describes one attempted confirmation of a SetupIntent, - whether that confirmation was successful or unsuccessful. You can use + whether that confirmation is successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent. properties: @@ -30934,6 +31272,14 @@ components: 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 used for this + Setup Intent. + nullable: true payment_method_options: anyOf: - $ref: '#/components/schemas/setup_intent_payment_method_options' @@ -31003,6 +31349,7 @@ components: - next_action - on_behalf_of - payment_method + - payment_method_configuration_details - payment_method_options - single_use_mandate x-resourceId: setup_intent @@ -35023,14 +35370,15 @@ components: tax_id: description: >- You can add one or multiple tax IDs to a - [customer](https://stripe.com/docs/api/customers). + [customer](https://stripe.com/docs/api/customers) or account. - A customer's tax IDs are displayed on invoices and credit notes issued - for the customer. + Customer and account tax IDs get displayed on related invoices and + credit notes. - Related guide: [Customer tax identification - numbers](https://stripe.com/docs/billing/taxes/tax-ids) + Related 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. @@ -44084,7 +44432,7 @@ paths: 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://stripe.com/docs/js/tokens_sources/create_token?type=pii). + Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). maxLength: 5000 type: string id_number_secondary: @@ -44094,7 +44442,7 @@ paths: 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://stripe.com/docs/js/tokens_sources/create_token?type=pii). + Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). maxLength: 5000 type: string last_name: @@ -44587,7 +44935,7 @@ paths: 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://stripe.com/docs/js/tokens_sources/create_token?type=pii). + Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). maxLength: 5000 type: string id_number_secondary: @@ -44597,7 +44945,7 @@ paths: 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://stripe.com/docs/js/tokens_sources/create_token?type=pii). + Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). maxLength: 5000 type: string last_name: @@ -45118,7 +45466,7 @@ paths: 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://stripe.com/docs/js/tokens_sources/create_token?type=pii). + Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). maxLength: 5000 type: string id_number_secondary: @@ -45128,7 +45476,7 @@ paths: 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://stripe.com/docs/js/tokens_sources/create_token?type=pii). + Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). maxLength: 5000 type: string last_name: @@ -45621,7 +45969,7 @@ paths: 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://stripe.com/docs/js/tokens_sources/create_token?type=pii). + Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). maxLength: 5000 type: string id_number_secondary: @@ -45631,7 +45979,7 @@ paths: 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://stripe.com/docs/js/tokens_sources/create_token?type=pii). + Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). maxLength: 5000 type: string last_name: @@ -50383,7 +50731,7 @@ paths: anyOf: - properties: message: - maxLength: 1000 + maxLength: 1200 type: string required: - message @@ -50396,7 +50744,20 @@ paths: anyOf: - properties: message: - maxLength: 1000 + 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 @@ -50899,6 +51260,12 @@ paths: - 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_options: description: Payment-method-specific configuration. properties: @@ -60874,8 +61241,8 @@ paths: type: array style: deepObject - description: >- - Filter links by their expiration status. By default, all links are - returned. + Filter links by their expiration status. By default, Stripe returns + all links. in: query name: expired required: false @@ -60988,9 +61355,7 @@ paths: type: string type: array expires_at: - description: >- - A future timestamp after which the link will no longer be - usable. + description: The link isn't usable after this future timestamp. format: unix-time type: integer file: @@ -61163,9 +61528,9 @@ paths: /v1/files: get: description: >- -

Returns a list of the files that your account has access to. The - files are returned sorted by creation date, with the most recently - created files appearing first.

+

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.

operationId: GetFiles parameters: - explode: true @@ -61221,8 +61586,8 @@ paths: type: integer style: form - description: >- - The file purpose to filter queries by. If none is provided, files - will not be filtered by purpose. + Filter queries by the file purpose. If you don't provide a purpose, + the queries return unfiltered files. in: query name: purpose required: false @@ -61315,14 +61680,13 @@ paths: description: Error response. post: description: >- -

To upload a file to Stripe, you’ll need to send a request of type - multipart/form-data. The request should contain the file - you would like to upload, as well as the parameters for creating a - file.

+

To upload a file to Stripe, you need to send a request of type + multipart/form-data. Include the file you want to upload in + the request, and the parameters for creating a file.

-

All of Stripe’s officially supported Client libraries should have - support for sending multipart/form-data.

+

All of Stripe’s officially supported Client libraries support sending + multipart/form-data.

operationId: PostFiles requestBody: content: @@ -61345,14 +61709,14 @@ paths: type: array file: description: >- - A file to upload. The file should follow the specifications - of RFC 2388 (which defines file transfers for the - `multipart/form-data` protocol). + 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 to automatically create a [file + Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file. properties: @@ -61414,11 +61778,10 @@ paths: '/v1/files/{file}': get: description: >- -

Retrieves the details of an existing file object. Supply the unique - file ID from a file, and Stripe will return the corresponding file - object. To access file contents, see the File Upload - Guide.

+

Retrieves the details of an existing file object. After you supply a + unique file ID, Stripe returns the corresponding file object. Learn how + to access file + contents.

operationId: GetFilesFile parameters: - description: Specifies which fields in the response should be expanded. @@ -63713,6 +64076,9 @@ paths: payment_settings: explode: true style: deepObject + rendering: + explode: true + style: deepObject rendering_options: explode: true style: deepObject @@ -64151,6 +64517,30 @@ paths: - include - include_and_require type: string + 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 + title: rendering_param + type: object rendering_options: anyOf: - properties: @@ -66079,6 +66469,9 @@ paths: payment_settings: explode: true style: deepObject + rendering: + explode: true + style: deepObject rendering_options: explode: true style: deepObject @@ -66489,6 +66882,30 @@ paths: 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 + title: rendering_param + type: object rendering_options: anyOf: - properties: @@ -67387,14 +67804,14 @@ paths: '/v1/issuing/authorizations/{authorization}/approve': post: description: >- -

Approves a pending Issuing Authorization object. This - request should be made within the timeout window of the [Deprecated] Approves a pending Issuing Authorization + object. This request should be made within the timeout window of the real-time authorization flow. - You can also respond directly to the webhook request to approve an - authorization (preferred). More details can be found here.

+ This method is deprecated. Instead, respond + directly to the webhook request to approve an authorization.

operationId: PostIssuingAuthorizationsAuthorizationApprove parameters: - in: path @@ -67466,14 +67883,14 @@ paths: '/v1/issuing/authorizations/{authorization}/decline': post: description: >- -

Declines a pending Issuing Authorization object. This - request should be made within the timeout window of the [Deprecated] Declines a pending Issuing Authorization + object. This request should be made within the timeout window of the real time authorization flow. - You can also respond directly to the webhook request to decline an - authorization (preferred). More details can be found here.

+ This method is deprecated. Instead, respond + directly to the webhook request to decline an authorization.

operationId: PostIssuingAuthorizationsAuthorizationDecline parameters: - in: path @@ -75106,6 +75523,12 @@ paths: you explicitly provide the `payment_method` going forward. maxLength: 5000 type: string + payment_method_configuration: + description: >- + The ID of the payment method configuration to use with this + PaymentIntent. + maxLength: 100 + type: string payment_method_data: description: >- If provided, this hash will be used to create a @@ -76750,15 +77173,16 @@ paths:

Updates properties on a PaymentIntent object without confirming.

-

Depending on which properties you update, you may need to confirm the +

Depending on which properties you update, you might need to confirm + the PaymentIntent again. For example, updating the - payment_method will + payment_method - always require you to confirm the PaymentIntent again. If you prefer to + always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties - via + through the confirm API instead.

@@ -76901,6 +77325,12 @@ paths: object) to attach to this PaymentIntent. maxLength: 5000 type: string + payment_method_configuration: + description: >- + The ID of the payment method configuration to use with this + PaymentIntent. + maxLength: 100 + type: string payment_method_data: description: >- If provided, this hash will be used to create a @@ -78189,10 +78619,9 @@ paths: type: object payment_method_types: description: >- - The list of payment method types (e.g. card) that this - PaymentIntent is allowed to use. Use - automatic_payment_methods to manage payment methods from the - [Stripe + 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 @@ -78305,9 +78734,9 @@ paths: type: string transfer_data: description: >- - The parameters used to automatically create a Transfer when - the payment succeeds. For more information, see the - PaymentIntents [use case for connected + 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: @@ -78317,10 +78746,9 @@ paths: transfer_group: description: >- A string that identifies the resulting payment as part of a - group. `transfer_group` may only be provided if it has not - been set. See the PaymentIntents [use case for connected - accounts](https://stripe.com/docs/payments/connected-accounts) - for details. + 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 @@ -80821,7 +81249,7 @@ paths: anyOf: - properties: message: - maxLength: 1000 + maxLength: 1200 type: string required: - message @@ -80834,7 +81262,20 @@ paths: anyOf: - properties: message: - maxLength: 1000 + 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 @@ -81635,7 +82076,7 @@ paths: anyOf: - properties: message: - maxLength: 1000 + maxLength: 1200 type: string required: - message @@ -81648,7 +82089,20 @@ paths: anyOf: - properties: message: - maxLength: 1000 + 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 @@ -82236,356 +82690,24 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - /v1/payment_method_domains: - get: - description:

Lists the details of existing payment method domains.

- 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. - post: - description:

Creates a payment method domain.

- 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. - '/v1/payment_method_domains/{payment_method_domain}': + /v1/payment_method_configurations: get: - description:

Retrieves the details of an existing payment method domain.

- operationId: GetPaymentMethodDomainsPaymentMethodDomain + description:

List payment method configurations

+ operationId: GetPaymentMethodConfigurations parameters: - - description: Specifies which fields in the response should be expanded. + - description: The Connect application to filter by. explode: true in: query - name: expand + name: application required: false schema: - items: - maxLength: 5000 - type: string - type: array + anyOf: + - maxLength: 100 + type: string + - enum: + - '' + type: string 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. - post: - description:

Updates an existing payment method domain.

- 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. - '/v1/payment_method_domains/{payment_method_domain}/validate': - post: - description: >- -

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. - - The payment method doesn’t appear in Elements for this domain until it - is active.

- - -

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.

- - -

Related guides: Payment method - domains.

- 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. - /v1/payment_methods: - get: - description: >- -

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 List a - Customer’s PaymentMethods API instead.

- 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: - type: string - style: form - description: Specifies which fields in the response should be expanded. explode: true in: query @@ -82597,72 +82719,6 @@ paths: 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: >- - 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 - - au_becs_debit - - bacs_debit - - bancontact - - blik - - boleto - - card - - cashapp - - customer_balance - - eps - - fpx - - giropay - - grabpay - - ideal - - klarna - - konbini - - link - - oxxo - - p24 - - paynow - - paypal - - pix - - promptpay - - sepa_debit - - sofort - - us_bank_account - - wechat_pay - - zip - type: string - x-stripeBypassValidation: true - style: form requestBody: content: application/x-www-form-urlencoded: @@ -82681,7 +82737,7 @@ paths: properties: data: items: - $ref: '#/components/schemas/payment_method' + $ref: '#/components/schemas/payment_method_configuration' type: array has_more: description: >- @@ -82698,14 +82754,13 @@ paths: 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 + title: PaymentMethodConfigResourcePaymentMethodConfigurationsList type: object x-expandableFields: - data @@ -82717,18 +82772,8 @@ paths: $ref: '#/components/schemas/error' description: Error response. post: - description: >- -

Creates a PaymentMethod object. Read the Stripe.js - reference to learn how to create PaymentMethods via Stripe.js.

- - -

Instead of creating a PaymentMethod directly, we recommend using the - PaymentIntents API to - accept a payment immediately or the SetupIntent API to collect - payment method details ahead of a future payment.

- operationId: PostPaymentMethods + description:

Creates a payment method configuration

+ operationId: PostPaymentMethodConfigurations requestBody: content: application/x-www-form-urlencoded: @@ -82745,6 +82790,12 @@ paths: alipay: explode: true style: deepObject + apple_pay: + explode: true + style: deepObject + apple_pay_later: + explode: true + style: deepObject au_becs_debit: explode: true style: deepObject @@ -82754,9 +82805,6 @@ paths: bancontact: explode: true style: deepObject - billing_details: - explode: true - style: deepObject blik: explode: true style: deepObject @@ -82766,10 +82814,10 @@ paths: card: explode: true style: deepObject - cashapp: + cartes_bancaires: explode: true style: deepObject - customer_balance: + cashapp: explode: true style: deepObject eps: @@ -82784,13 +82832,16 @@ paths: giropay: explode: true style: deepObject + google_pay: + explode: true + style: deepObject grabpay: explode: true style: deepObject ideal: explode: true style: deepObject - interac_present: + jcb: explode: true style: deepObject klarna: @@ -82802,9 +82853,6 @@ paths: link: explode: true style: deepObject - metadata: - explode: true - style: deepObject oxxo: explode: true style: deepObject @@ -82817,15 +82865,9 @@ paths: paypal: explode: true style: deepObject - pix: - explode: true - style: deepObject promptpay: explode: true style: deepObject - radar_options: - explode: true - style: deepObject sepa_debit: explode: true style: deepObject @@ -82838,20 +82880,2251 @@ paths: 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. + Canadian pre-authorized debit payments, check this + [page](https://stripe.com/docs/payments/acss-debit) for more + details like country availability. properties: - account_number: - maxLength: 5000 - type: string + 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 + 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 + 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 the US, Canada, + Australia, New Zealand, UK, and Ireland. 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 + 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 + 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 + 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 + 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-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 + 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. + '/v1/payment_method_configurations/{configuration}': + get: + description:

Retrieve payment method configuration

+ 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. + post: + description:

Update payment method configuration

+ 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 + 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 + 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 + oxxo: + explode: true + style: deepObject + p24: + explode: true + style: deepObject + paynow: + explode: true + style: deepObject + paypal: + explode: true + style: deepObject + promptpay: + explode: true + style: deepObject + sepa_debit: + explode: true + style: deepObject + sofort: + explode: true + style: deepObject + us_bank_account: + explode: true + style: deepObject + wechat_pay: + 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 + 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 + 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 the US, Canada, + Australia, New Zealand, UK, and Ireland. 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 + 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 + 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 + 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 + 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-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 + 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. + /v1/payment_method_domains: + get: + description:

Lists the details of existing payment method domains.

+ 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. + post: + description:

Creates a payment method domain.

+ 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. + '/v1/payment_method_domains/{payment_method_domain}': + get: + description:

Retrieves the details of an existing payment method domain.

+ 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. + post: + description:

Updates an existing payment method domain.

+ 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. + '/v1/payment_method_domains/{payment_method_domain}/validate': + post: + description: >- +

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. + + The payment method doesn’t appear in Elements for this domain until it + is active.

+ + +

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.

+ + +

Related guides: Payment method + domains.

+ 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. + /v1/payment_methods: + get: + description: >- +

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 List a + Customer’s PaymentMethods API instead.

+ 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: + 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: >- + 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 + - au_becs_debit + - bacs_debit + - bancontact + - blik + - boleto + - card + - cashapp + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - klarna + - konbini + - link + - oxxo + - p24 + - paynow + - paypal + - pix + - promptpay + - sepa_debit + - sofort + - 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. + post: + description: >- +

Creates a PaymentMethod object. Read the Stripe.js + reference to learn how to create PaymentMethods via Stripe.js.

+ + +

Instead of creating a PaymentMethod directly, we recommend using the + PaymentIntents API to + accept a payment immediately or the SetupIntent API to collect + payment method details ahead of a future payment.

+ 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 + 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 + klarna: + explode: true + style: deepObject + konbini: + explode: true + style: deepObject + link: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + oxxo: + explode: true + style: deepObject + p24: + 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 + sepa_debit: + explode: true + style: deepObject + sofort: + 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 @@ -90714,13 +92987,13 @@ paths: /v1/setup_attempts: get: description: >- -

Returns a list of SetupAttempts associated with a provided +

Returns a list of SetupAttempts that associate with a provided SetupIntent.

operationId: GetSetupAttempts 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 + can be a string with an integer Unix timestamp or a dictionary with a number of different query options. explode: true in: query @@ -91200,6 +93473,12 @@ paths: Source object) to attach to this SetupIntent. maxLength: 5000 type: string + payment_method_configuration: + description: >- + The ID of the payment method configuration to use with this + Setup Intent. + maxLength: 100 + type: string payment_method_data: description: >- When included, this hash creates a PaymentMethod that is set @@ -92056,6 +94335,12 @@ paths: Source object) to attach to this SetupIntent. maxLength: 5000 type: string + payment_method_configuration: + description: >- + The ID of the payment method configuration to use with this + SetupIntent. + maxLength: 100 + type: string payment_method_data: description: >- When included, this hash creates a PaymentMethod that is set @@ -111415,7 +113700,6 @@ paths: - issuing_transaction.created - issuing_transaction.updated - mandate.updated - - order.created - payment_intent.amount_capturable_updated - payment_intent.canceled - payment_intent.created @@ -111456,9 +113740,6 @@ paths: - quote.finalized - radar.early_fraud_warning.created - radar.early_fraud_warning.updated - - recipient.created - - recipient.deleted - - recipient.updated - refund.created - refund.updated - reporting.report_run.failed @@ -111472,9 +113753,6 @@ paths: - setup_intent.setup_failed - setup_intent.succeeded - sigma.scheduled_query_run.created - - sku.created - - sku.deleted - - sku.updated - source.canceled - source.chargeable - source.failed @@ -111816,7 +114094,6 @@ paths: - issuing_transaction.created - issuing_transaction.updated - mandate.updated - - order.created - payment_intent.amount_capturable_updated - payment_intent.canceled - payment_intent.created @@ -111857,9 +114134,6 @@ paths: - quote.finalized - radar.early_fraud_warning.created - radar.early_fraud_warning.updated - - recipient.created - - recipient.deleted - - recipient.updated - refund.created - refund.updated - reporting.report_run.failed @@ -111873,9 +114147,6 @@ paths: - setup_intent.setup_failed - setup_intent.succeeded - sigma.scheduled_query_run.created - - sku.created - - sku.deleted - - sku.updated - source.canceled - source.chargeable - source.failed diff --git a/packages/openapi-typescript/src/transform/components-object.ts b/packages/openapi-typescript/src/transform/components-object.ts index 4ab1d10f6..d4e299c59 100644 --- a/packages/openapi-typescript/src/transform/components-object.ts +++ b/packages/openapi-typescript/src/transform/components-object.ts @@ -51,8 +51,6 @@ export default function transformComponentsObject(components: ComponentsObject, const parameters: string[] = []; indentLv++; - let isEveryParameterOptional = true; - for (const [name, parameterObject] of getEntries(components.parameters, ctx.alphabetize, ctx.excludeDeprecated)) { const c = getSchemaObjectComment(parameterObject, indentLv); if (c) parameters.push(indent(c, indentLv)); @@ -60,12 +58,9 @@ export default function transformComponentsObject(components: ComponentsObject, if (ctx.immutableTypes) key = tsReadonly(key); if ("$ref" in parameterObject) { parameters.push(indent(`${key}: ${transformSchemaObject(parameterObject, { path: `#/components/parameters/${name}`, ctx })};`, indentLv)); - isEveryParameterOptional = false; } else { if (parameterObject.in !== "path" && !parameterObject.required) { key = tsOptionalProperty(key); - } else { - isEveryParameterOptional = false; } const parameterType = transformParameterObject(parameterObject, { path: `#/components/parameters/${name}`, @@ -75,8 +70,7 @@ export default function transformComponentsObject(components: ComponentsObject, } } indentLv--; - const parametersKey = isEveryParameterOptional ? tsOptionalProperty("parameters") : "parameters"; - output.push(indent(`${parametersKey}: {`, indentLv), ...parameters, indent("};", indentLv)); + output.push(indent(`parameters: {`, indentLv), ...parameters, indent("};", indentLv)); } else { output.push(indent("parameters: never;", indentLv)); } diff --git a/packages/openapi-typescript/src/transform/operation-object.ts b/packages/openapi-typescript/src/transform/operation-object.ts index 763a97f6c..0671772f4 100644 --- a/packages/openapi-typescript/src/transform/operation-object.ts +++ b/packages/openapi-typescript/src/transform/operation-object.ts @@ -15,6 +15,7 @@ export default function transformOperationObject(operationObject: OperationObjec let { indentLv } = ctx; const output: string[] = wrapObject ? ["{"] : []; indentLv++; + let allParamsOptional = true; // parameters { @@ -24,15 +25,17 @@ export default function transformOperationObject(operationObject: OperationObjec for (const paramIn of ["query", "header", "path", "cookie"] as ParameterObject["in"][]) { const paramInternalOutput: string[] = []; indentLv++; - let allOptional = true; + let paramInOptional = true; for (const param of operationObject.parameters ?? []) { const node: ParameterObject | undefined = "$ref" in param ? ctx.parameters[param.$ref] : param; if (node?.in !== paramIn) continue; let key = escObjKey(node.name); - if (paramIn !== "path" && !node.required) { - key = tsOptionalProperty(key); + const isRequired = paramIn === "path" || !!node.required; + if (isRequired) { + allParamsOptional = false; + paramInOptional = false; } else { - allOptional = false; + key = tsOptionalProperty(key); } const c = getSchemaObjectComment(param, indentLv); if (c) paramInternalOutput.push(indent(c, indentLv)); @@ -47,7 +50,7 @@ export default function transformOperationObject(operationObject: OperationObjec } indentLv--; if (paramInternalOutput.length) { - const key = allOptional ? tsOptionalProperty(paramIn) : paramIn; + const key = paramInOptional ? tsOptionalProperty(paramIn) : paramIn; parameterOutput.push(indent(`${key}: {`, indentLv)); parameterOutput.push(...paramInternalOutput); parameterOutput.push(indent(`};`, indentLv)); @@ -56,7 +59,8 @@ export default function transformOperationObject(operationObject: OperationObjec indentLv--; if (parameterOutput.length) { - output.push(indent(`parameters: {`, indentLv)); + const parameterKey = allParamsOptional ? tsOptionalProperty("parameters") : "parameters"; + output.push(indent(`${parameterKey}: {`, indentLv)); output.push(parameterOutput.join("\n")); output.push(indent("};", indentLv)); } diff --git a/packages/openapi-typescript/test/components-object.test.ts b/packages/openapi-typescript/test/components-object.test.ts index b1d240076..1ab7bd925 100644 --- a/packages/openapi-typescript/test/components-object.test.ts +++ b/packages/openapi-typescript/test/components-object.test.ts @@ -293,7 +293,7 @@ describe("Components Object", () => { expect(generated).toBe(`{ schemas: never; responses: never; - parameters?: { + parameters: { myParam?: string; myParam2?: string; }; diff --git a/packages/openapi-typescript/test/index.test.ts b/packages/openapi-typescript/test/index.test.ts index dc1254a14..4d97a243a 100644 --- a/packages/openapi-typescript/test/index.test.ts +++ b/packages/openapi-typescript/test/index.test.ts @@ -238,7 +238,7 @@ export type operations = Record; export interface paths { "/post/{id}": { get: operations["getPost"]; - parameters: { + parameters?: { query?: { revision?: number; }; diff --git a/packages/openapi-typescript/test/operation-object.test.ts b/packages/openapi-typescript/test/operation-object.test.ts index a30addb18..87a96c6bd 100644 --- a/packages/openapi-typescript/test/operation-object.test.ts +++ b/packages/openapi-typescript/test/operation-object.test.ts @@ -19,6 +19,8 @@ const ctx: GlobalContext = { excludeDeprecated: false, }; +const options = { ctx, path: "#/paths/~get-item" }; + describe("Operation Object", () => { it("allows 2XX codes", () => { const schema: OperationObject = { @@ -45,7 +47,7 @@ describe("Operation Object", () => { }, }, }; - const generated = transformOperationObject(schema, { ctx, path: "#/paths/~get-item" }); + const generated = transformOperationObject(schema, options); expect(generated).toBe(`{ responses: { /** @description OK */ @@ -67,6 +69,99 @@ describe("Operation Object", () => { }; }; }; +}`); + }); + + it("marks parameters optional if they are all optional", () => { + const schema: OperationObject = { + parameters: [ + { + in: "query", + name: "search", + schema: { type: "string" }, + }, + { + in: "header", + name: "x-header", + schema: { type: "string" }, + required: false, + }, + ], + responses: { + "200": { + description: "OK", + content: { + "application/json": { + schema: { type: "string" }, + }, + }, + }, + }, + }; + const generated = transformOperationObject(schema, options); + expect(generated).toBe(`{ + parameters?: { + query?: { + search?: string; + }; + header?: { + "x-header"?: string; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": string; + }; + }; + }; +}`); + }); + + it("marks parameters required if there are any path params", () => { + const schema: OperationObject = { + parameters: [ + { + in: "path", + name: "user_id", + schema: { type: "string" }, + }, + { + in: "query", + name: "search", + schema: { type: "string" }, + }, + ], + responses: { + "200": { + description: "OK", + content: { + "application/json": { + schema: { type: "string" }, + }, + }, + }, + }, + }; + const generated = transformOperationObject(schema, options); + expect(generated).toBe(`{ + parameters: { + query?: { + search?: string; + }; + path: { + user_id: string; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": string; + }; + }; + }; }`); }); }); diff --git a/packages/openapi-typescript/test/paths-object.test.ts b/packages/openapi-typescript/test/paths-object.test.ts index 8a79598b9..7d5c2b64a 100644 --- a/packages/openapi-typescript/test/paths-object.test.ts +++ b/packages/openapi-typescript/test/paths-object.test.ts @@ -86,7 +86,7 @@ describe("Paths Object", () => { 404: components["responses"]["NotFound"]; }; }; - parameters: { + parameters?: { query?: { /** @description Page number. */ page?: number; @@ -187,7 +187,7 @@ describe("Paths Object", () => { expect(generated).toBe(`{ "/api/v1/user/me": { get: { - parameters: { + parameters?: { query?: { /** @description Page number. */ page?: number; @@ -210,7 +210,7 @@ describe("Paths Object", () => { 404: components["responses"]["NotFound"]; }; }; - parameters: { + parameters?: { query?: { /** @description Page number. */ page?: number;