diff --git a/docs/cli.md b/docs/cli.md index de5262d20..ecef563b0 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -120,6 +120,7 @@ The following flags are supported in the CLI: | `--immutable` | | `false` | Generates immutable types (readonly properties and readonly array) | | `--path-params-as-types` | | `false` | Allow dynamic string lookups on the `paths` object | | `--root-types` | | `false` | Exports types from `components` as root level type aliases | +| `--root-types-no-schema-prefix` | | `false` | Do not add "Schema" prefix to types at the root level (should only be used with --root-types) | ### pathParamsAsTypes diff --git a/packages/openapi-typescript/bin/cli.js b/packages/openapi-typescript/bin/cli.js index a974cc488..6cfdec986 100755 --- a/packages/openapi-typescript/bin/cli.js +++ b/packages/openapi-typescript/bin/cli.js @@ -31,6 +31,8 @@ Options --alphabetize Sort object keys alphabetically --exclude-deprecated Exclude deprecated types --root-types (optional) Export schemas types at root level + --root-types-no-schema-prefix (optional) + Do not add "Schema" prefix to types at the root level (should only be used with --root-types) `; const OUTPUT_FILE = "FILE"; @@ -56,6 +58,9 @@ if (args.includes("-it")) { if (args.includes("--redoc")) { errorAndExit(`The --redoc config flag has been renamed to "--redocly" (or -c as shorthand).`); } +if (args.includes("--root-types-no-schema-prefix") && !args.includes("--root-types")) { + console.warn("--root-types-no-schema-prefix has no effect without --root-types flag"); +} const flags = parser(args, { boolean: [ @@ -76,6 +81,7 @@ const flags = parser(args, { "immutable", "pathParamsAsTypes", "rootTypes", + "rootTypesNoSchemaPrefix", ], string: ["output", "redocly"], alias: { @@ -136,6 +142,7 @@ async function generateSchema(schema, { redocly, silent = false }) { immutable: flags.immutable, pathParamsAsTypes: flags.pathParamsAsTypes, rootTypes: flags.rootTypes, + rootTypesNoSchemaPrefix: flags.rootTypesNoSchemaPrefix, redocly, silent, }), diff --git a/packages/openapi-typescript/examples/digital-ocean-api.ts b/packages/openapi-typescript/examples/digital-ocean-api.ts index a2a213b96..85271084b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api.ts +++ b/packages/openapi-typescript/examples/digital-ocean-api.ts @@ -701,9 +701,11 @@ export interface paths { * `/v2/cdn/endpoints/$ENDPOINT_ID/cache`. The body of the request should include * a `files` attribute containing a list of cached file paths to be purged. A * path may be for a single file or may contain a wildcard (`*`) to recursively - * purge all files under a directory. When only a wildcard is provided, all - * cached files will be purged. There is a rate limit of 50 files per 20 seconds - * that can be purged. + * purge all files under a directory. When only a wildcard is provided, all cached + * files will be purged. There is a rate limit of 50 files per 20 seconds that can + * be purged. CDN endpoints have a rate limit of 5 requests per 10 seconds. + * Purging files using a wildcard path counts as a single request against the API's + * rate limit. Two identical purge requests cannot be sent at the same time. * */ delete: operations["cdn_purge_cache"]; @@ -1165,7 +1167,7 @@ export interface paths { get: operations["databases_list_firewall_rules"]; /** * Update Firewall Rules (Trusted Sources) for a Database - * @description To update a database cluster's firewall rules (known as "trusted sources" in the control panel), send a PUT request to `/v2/databases/$DATABASE_ID/firewall` specifying which resources should be able to open connections to the database. You may limit connections to specific Droplets, Kubernetes clusters, or IP addresses. When a tag is provided, any Droplet or Kubernetes node with that tag applied to it will have access. The firewall is limited to 100 rules (or trusted sources). When possible, we recommend [placing your databases into a VPC network](https://www.digitalocean.com/docs/networking/vpc/) to limit access to them instead of using a firewall. + * @description To update a database cluster's firewall rules (known as "trusted sources" in the control panel), send a PUT request to `/v2/databases/$DATABASE_ID/firewall` specifying which resources should be able to open connections to the database. You may limit connections to specific Droplets, Kubernetes clusters, or IP addresses. When a tag is provided, any Droplet or Kubernetes node with that tag applied to it will have access. The firewall is limited to 100 rules (or trusted sources). When possible, we recommend [placing your databases into a VPC network](https://docs.digitalocean.com/products/networking/vpc/) to limit access to them instead of using a firewall. * A successful */ put: operations["databases_update_firewall_rules"]; @@ -1578,7 +1580,7 @@ export interface paths { * Add a New Connection Pool (PostgreSQL) * @description For PostgreSQL database clusters, connection pools can be used to allow a * database to share its idle connections. The popular PostgreSQL connection - * pooling utility PgBouncer is used to provide this service. [See here for more information](https://www.digitalocean.com/docs/databases/postgresql/how-to/manage-connection-pools/) + * pooling utility PgBouncer is used to provide this service. [See here for more information](https://docs.digitalocean.com/products/databases/postgresql/how-to/manage-connection-pools/) * about how and why to use PgBouncer connection pooling including * details about the available transaction modes. * @@ -2073,6 +2075,11 @@ export interface paths { * parameter set to the name of the tag in your GET request. For example, * `/v2/droplets?tag_name=$TAG_NAME`. * + * ### GPU Droplets + * + * By default, only non-GPU Droplets are returned. To list only GPU Droplets, set + * the `type` query parameter to `gpus`. For example, `/v2/droplets?type=gpus`. + * */ get: operations["droplets_list"]; put?: never; @@ -3164,7 +3171,7 @@ export interface paths { * The request may contain a maintenance window policy describing a time period * when disruptive maintenance tasks may be carried out. Omitting the policy * implies that a window will be chosen automatically. See - * [here](https://www.digitalocean.com/docs/kubernetes/how-to/upgrade-cluster/) + * [here](https://docs.digitalocean.com/products/kubernetes/how-to/upgrade-cluster/) * for details. * */ @@ -3302,7 +3309,7 @@ export interface paths { * The resulting kubeconfig file uses token-based authentication for clusters * supporting it, and certificate-based authentication otherwise. For a list of * supported versions and more information, see "[How to Connect to a DigitalOcean - * Kubernetes Cluster with kubectl](https://www.digitalocean.com/docs/kubernetes/how-to/connect-with-kubectl/)". + * Kubernetes Cluster](https://docs.digitalocean.com/products/kubernetes/how-to/connect-to-cluster/)". * * To retrieve a kubeconfig file for use with a Kubernetes cluster, send a GET * request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig`. @@ -3338,7 +3345,7 @@ export interface paths { * The resulting JSON object contains token-based authentication for clusters * supporting it, and certificate-based authentication otherwise. For a list of * supported versions and more information, see "[How to Connect to a DigitalOcean - * Kubernetes Cluster with kubectl](https://www.digitalocean.com/docs/kubernetes/how-to/connect-with-kubectl/)". + * Kubernetes Cluster](https://docs.digitalocean.com/products/kubernetes/how-to/connect-to-cluster/)". * * To retrieve credentials for accessing a Kubernetes cluster, send a GET * request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/credentials`. @@ -4672,6 +4679,108 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/monitoring/sinks/destinations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Logging Destinations + * @description To list all logging destinations, send a GET request to `/v2/monitoring/sinks/destinations`. + */ + get: operations["monitoring_list_destinations"]; + put?: never; + /** + * Create Logging Destination + * @description To create a new destination, send a POST request to `/v2/monitoring/sinks/destinations`. + */ + post: operations["monitoring_create_destination"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/sinks/destinations/{destination_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Logging Destination + * @description To get the details of a destination, send a GET request to `/v2/monitoring/sinks/destinations/${destination_uuid}`. + */ + get: operations["monitoring_get_destination"]; + put?: never; + /** + * Update Logging Destination + * @description To update the details of a destination, send a PATCH request to `/v2/monitoring/sinks/destinations/${destination_uuid}`. + */ + post: operations["monitoring_update_destination"]; + /** + * Delete Logging Destination + * @description To delete a destination and all associated sinks, send a DELETE request to `/v2/monitoring/sinks/destinations/${destination_uuid}`. + */ + delete: operations["monitoring_delete_destination"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/sinks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Lists all sinks + * @description To list all sinks, send a GET request to `/v2/monitoring/sinks`. + */ + get: operations["monitoring_list_sinks"]; + put?: never; + /** + * Create Sink + * @description To create a new sink, send a POST request to `/v2/monitoring/sinks`. Forwards logs from the + * resources identified in `resources` to the specified pre-existing destination. + * + */ + post: operations["monitoring_create_sink"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/sinks/{sink_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Sink + * @description To get the details of a sink (resources and destination), send a GET request to `/v2/monitoring/sinks/${sink_uuid}`. + */ + get: operations["monitoring_get_sink"]; + put?: never; + post?: never; + /** + * Delete Sink + * @description To delete a sink, send a DELETE request to `/v2/monitoring/sinks/${sink_uuid}`. + */ + delete: operations["monitoring_delete_sink"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/projects": { parameters: { query?: never; @@ -5134,7 +5243,7 @@ export interface paths { * manifest data) after deleting one or more manifests from a repository. If * there are no unreferenced blobs resulting from the deletion of one or more * manifests, garbage collection is effectively a noop. - * [See here for more information](https://www.digitalocean.com/docs/container-registry/how-to/clean-up-container-registry/) + * [See here for more information](https://docs.digitalocean.com/products/container-registry/how-to/clean-up-container-registry/) * about how and why you should clean up your container registry periodically. * * To request a garbage collection run on your registry, send a POST request to @@ -5603,7 +5712,7 @@ export interface paths { * volumes may be attached to a Droplet at a time. Pre-formatted volumes will be * automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS * Droplets created on or after April 26, 2018 when attached. On older Droplets, - * [additional configuration](https://www.digitalocean.com/community/tutorials/how-to-partition-and-format-digitalocean-block-storage-volumes-in-linux#mounting-the-filesystems) + * [additional configuration](https://docs.digitalocean.com/products/volumes/how-to/mount/) * is required. * * ## Remove a Block Storage Volume from a Droplet @@ -5716,7 +5825,7 @@ export interface paths { * volumes may be attached to a Droplet at a time. Pre-formatted volumes will be * automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS * Droplets created on or after April 26, 2018 when attached. On older Droplets, - * [additional configuration](https://www.digitalocean.com/community/tutorials/how-to-partition-and-format-digitalocean-block-storage-volumes-in-linux#mounting-the-filesystems) + * [additional configuration](https://docs.digitalocean.com/products/volumes/how-to/mount/) * is required. * * ## Remove a Block Storage Volume from a Droplet @@ -5891,6 +6000,116 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/vpcs/{vpc_id}/peerings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List the Peerings of a VPC + * @description To list all of a VPC's peerings, send a GET request to + * `/v2/vpcs/$VPC_ID/peerings`. + * + */ + get: operations["vpcs_list_peerings"]; + put?: never; + /** + * Create a Peering with a VPC + * @description To create a new VPC peering for a given VPC, send a POST request to + * `/v2/vpcs/$VPC_ID/peerings`. + * + */ + post: operations["vpcs_create_peerings"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/vpcs/{vpc_id}/peerings/{vpc_peering_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Update a VPC Peering + * @description To update the name of a VPC peering in a particular VPC, send a PATCH request + * to `/v2/vpcs/$VPC_ID/peerings/$VPC_PEERING_ID` with the new `name` in the + * request body. + * + */ + patch: operations["vpcs_patch_peerings"]; + trace?: never; + }; + "/v2/vpc_peerings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All VPC Peerings + * @description To list all of the VPC peerings on your account, send a GET request to `/v2/vpc_peerings`. + */ + get: operations["vpcPeerings_list"]; + put?: never; + /** + * Create a New VPC Peering + * @description To create a new VPC Peering, send a POST request to `/v2/vpc_peerings` + * specifying a name and a list of two VPC IDs to peer. The response code, 202 + * Accepted, does not indicate the success or failure of the operation, just + * that the request has been accepted for processing. + * + */ + post: operations["vpcPeerings_create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/vpc_peerings/{vpc_peering_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve an Existing VPC Peering + * @description To show information about an existing VPC Peering, send a GET request to `/v2/vpc_peerings/$VPC_PEERING_ID`. + * + */ + get: operations["vpcPeerings_get"]; + put?: never; + post?: never; + /** + * Delete a VPC peering + * @description To delete a VPC peering, send a DELETE request to `/v2/vpc_peerings/$VPC_PEERING_ID`. + * + */ + delete: operations["vpcPeerings_delete"]; + options?: never; + head?: never; + /** + * Update a VPC peering + * @description To update the name of a VPC peering, send a PATCH request to `/v2/vpc_peerings/$VPC_PEERING_ID` with the new `name` in the request body. + * + */ + patch: operations["vpcPeerings_patch"]; + trace?: never; + }; "/v2/uptime/checks": { parameters: { query?: never; @@ -6267,11 +6486,6 @@ export interface components { */ sizes: unknown; }; - /** - * @description A human-readable string that is used as a unique identifier for each region. - * @example nyc3 - */ - slug: string; action: { /** * @description A unique numeric ID that can be used to identify and reference an action. @@ -6313,7 +6527,11 @@ export interface components { */ resource_type?: string; region?: components["schemas"]["region"]; - region_slug?: components["schemas"]["slug"] & (string | null); + /** + * @description A human-readable string that is used as a unique identifier for each region. + * @example nyc3 + */ + region_slug?: string | null; }; apps_deployment_job: { /** @@ -6719,7 +6937,7 @@ export interface components { /** @description A list of environment variables made available to the component. */ envs?: components["schemas"]["app_variable_definition"][]; /** - * @description An environment slug describing the type of this app. For a full list, please refer to [the product documentation](https://www.digitalocean.com/docs/app-platform/). + * @description An environment slug describing the type of this app. For a full list, please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/). * @example node-js */ environment_slug?: string; @@ -6736,11 +6954,9 @@ export interface components { instance_count: number; /** * @description The instance size to use for this component. Default: `apps-s-1vcpu-0.5gb` - * @default apps-s-1vcpu-0.5gb * @example apps-s-1vcpu-0.5gb - * @enum {string} */ - instance_size_slug: "apps-s-1vcpu-0.5gb" | "apps-s-1vcpu-1gb-fixed" | "apps-s-1vcpu-1gb" | "apps-s-1vcpu-2gb" | "apps-s-2vcpu-4gb" | "apps-d-1vcpu-0.5gb" | "apps-d-1vcpu-1gb" | "apps-d-1vcpu-2gb" | "apps-d-1vcpu-4gb" | "apps-d-2vcpu-4gb" | "apps-d-2vcpu-8gb" | "apps-d-4vcpu-8gb" | "apps-d-4vcpu-16gb" | "apps-d-8vcpu-32gb"; + instance_size_slug?: ("apps-s-1vcpu-0.5gb" | "apps-s-1vcpu-1gb-fixed" | "apps-s-1vcpu-1gb" | "apps-s-1vcpu-2gb" | "apps-s-2vcpu-4gb" | "apps-d-1vcpu-0.5gb" | "apps-d-1vcpu-1gb" | "apps-d-1vcpu-2gb" | "apps-d-1vcpu-4gb" | "apps-d-2vcpu-4gb" | "apps-d-2vcpu-8gb" | "apps-d-4vcpu-8gb" | "apps-d-4vcpu-16gb" | "apps-d-8vcpu-32gb") | ("basic-xxs" | "basic-xs" | "basic-s" | "basic-m" | "professional-xs" | "professional-s" | "professional-m" | "professional-1l" | "professional-l" | "professional-xl"); /** @description Configuration for automatically scaling this component based on metrics. */ autoscaling?: { /** @@ -6913,6 +7129,16 @@ export interface components { app_service_spec: components["schemas"]["app_component_base"] & components["schemas"]["app_component_instance_base"] & { cors?: components["schemas"]["apps_cors_policy"] & unknown & unknown; health_check?: components["schemas"]["app_service_spec_health_check"]; + /** + * @description The protocol which the service uses to serve traffic on the http_port. + * + * - `HTTP`: The app is serving the HTTP protocol. Default. + * - `HTTP2`: The app is serving the HTTP/2 protocol. Currently, this needs to be implemented in the service by serving HTTP/2 cleartext (h2c). + * + * @example HTTP + * @enum {string} + */ + protocol?: "HTTP" | "HTTP2"; /** * Format: int64 * @description The internal port on which this service's run command will listen. Default: 8080 @@ -7183,6 +7409,19 @@ export interface components { app_egress_spec: { type?: components["schemas"]["app_egress_type_spec"]; }; + /** @description Specification to configure maintenance settings for the app, such as maintenance mode and archiving the app. */ + app_maintenance_spec: { + /** + * @description Indicates whether maintenance mode should be enabled for the app. + * @example true + */ + enabled?: boolean; + /** + * @description Indicates whether the app should be archived. Setting this to true implies that enabled is set to true. Note that this feature is currently in closed beta. + * @example true + */ + archive?: boolean; + }; /** * AppSpec * @description The desired configuration of an application. @@ -7216,6 +7455,7 @@ export interface components { databases?: components["schemas"]["app_database_spec"][]; ingress?: components["schemas"]["app_ingress_spec"]; egress?: components["schemas"]["app_egress_spec"]; + maintenance?: components["schemas"]["app_maintenance_spec"]; }; apps_deployment_static_site: { /** @@ -9383,6 +9623,11 @@ export interface components { * @example false */ stat_monitor_enable?: boolean; + /** + * @description Number of seconds of master unavailability before triggering database failover to standby. The default value is 60. + * @example 50 + */ + max_failover_replication_time_lag?: number; }; /** * @description A string specifying the desired eviction policy for the Redis cluster. @@ -9427,7 +9672,10 @@ export interface components { */ redis_lfu_decay_time: number; /** - * @description Require SSL to access Redis + * @description Require SSL to access Redis. + * - When enabled, Redis accepts only SSL connections on port `25061`. + * - When disabled, port `25060` is opened for non-SSL connections, while port `25061` remains available for SSL connections. + * * @default true * @example true */ @@ -9882,6 +10130,12 @@ export interface components { * ] */ reindex_remote_whitelist?: string[]; + /** + * @description Enable or disable filtering of alerting by backend roles. + * @default false + * @example false + */ + plugins_alerting_filter_by_backend_roles_enabled: boolean; }; mongo_advanced_config: { /** @@ -10708,12 +10962,32 @@ export interface components { domain_record_soa: components["schemas"]["domain_record"] & unknown; domain_record_srv: components["schemas"]["domain_record"] & unknown; domain_record_txt: components["schemas"]["domain_record"] & unknown; + disk_info: { + /** + * @description The type of disk. All Droplets contain a `local` disk. Additionally, GPU Droplets can also have a `scratch` disk for non-persistent data. + * @example local + * @enum {string} + */ + type?: "local" | "scratch"; + size?: { + /** + * @description The amount of space allocated to the disk. + * @example 25 + */ + amount?: number; + /** + * @description The unit of measure for the disk size. + * @example gib + */ + unit?: string; + }; + }; /** * @deprecated * @description **Note**: All Droplets created after March 2017 use internal kernels by default. * These Droplets will have this attribute set to `null`. * - * The current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/) + * The current [kernel](https://docs.digitalocean.com/products/droplets/how-to/kernel/) * for Droplets with externally managed kernels. This will initially be set to * the kernel of the base image when the Droplet is created. * @@ -10765,7 +11039,7 @@ export interface components { * @example nyc3 * @enum {string} */ - region_slug: "ams1" | "ams2" | "ams3" | "blr1" | "fra1" | "lon1" | "nyc1" | "nyc2" | "nyc3" | "sfo1" | "sfo2" | "sfo3" | "sgp1" | "tor1"; + region_slug: "ams1" | "ams2" | "ams3" | "blr1" | "fra1" | "lon1" | "nyc1" | "nyc2" | "nyc3" | "sfo1" | "sfo2" | "sfo3" | "sgp1" | "tor1" | "syd1"; /** * @description This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values. * @example [ @@ -10845,6 +11119,31 @@ export interface components { */ error_message?: string; }; + /** @description An object containing information about the GPU capabilities of Droplets created with this size. */ + gpu_info: { + /** + * @description The number of GPUs allocated to the Droplet. + * @example 1 + */ + count?: number; + /** + * @description The model of the GPU. + * @example nvidia_h100 + */ + model?: string; + vram?: { + /** + * @description The amount of VRAM allocated to the GPU. + * @example 25 + */ + amount?: number; + /** + * @description The unit of measure for the VRAM. + * @example gib + */ + unit?: string; + }; + }; size: { /** * @description A human-readable string that is used to uniquely identify each size. @@ -10857,7 +11156,7 @@ export interface components { */ memory: number; /** - * @description The integer of number CPUs allocated to Droplets of this size. + * @description The number of CPUs allocated to Droplets of this size. * @example 1 */ vcpus: number; @@ -10914,6 +11213,9 @@ export interface components { * @example Basic */ description: string; + /** @description An array of objects containing information about the disks available to Droplets created with this size. */ + disk_info?: components["schemas"]["disk_info"][]; + gpu_info?: components["schemas"]["gpu_info"]; }; network_v4: { /** @@ -10998,6 +11300,8 @@ export interface components { * @example 25 */ disk: number; + /** @description An array of objects containing information about the disks available to the Droplet. */ + disk_info?: components["schemas"]["disk_info"][]; /** * @description A boolean value indicating whether the Droplet has been locked, preventing actions by users. * @example false @@ -11073,6 +11377,7 @@ export interface components { * @example 760e09ef-dc84-11e8-981e-3cfdfeaae000 */ vpc_uuid?: string; + gpu_info?: components["schemas"]["gpu_info"]; }; droplet_backup_policy: { /** @@ -12056,15 +12361,16 @@ export interface components { version: string; /** * Format: cidr - * @description The range of IP addresses in the overlay network of the Kubernetes cluster in CIDR notation. - * @example 10.244.0.0/16 + * @description The range of IP addresses for the overlay network of the Kubernetes cluster in CIDR notation. + * @example 192.168.0.0/20 */ - readonly cluster_subnet?: string; + cluster_subnet?: string; /** + * Format: cidr * @description The range of assignable IP addresses for services running in the Kubernetes cluster in CIDR notation. - * @example 10.245.0.0/16 + * @example 192.168.16.0/24 */ - readonly service_subnet?: string; + service_subnet?: string; /** * Format: uuid * @description A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned. @@ -12273,7 +12579,7 @@ export interface components { * * Newly created Kubernetes clusters do not return credentials using * certificate-based authentication. For additional information, - * [see here](https://www.digitalocean.com/docs/kubernetes/how-to/connect-to-cluster/#authenticate). + * [see here](https://docs.digitalocean.com/products/kubernetes/how-to/connect-to-cluster/#authenticate). * * @example null */ @@ -12287,7 +12593,7 @@ export interface components { * * Newly created Kubernetes clusters do not return credentials using * certificate-based authentication. For additional information, - * [see here](https://www.digitalocean.com/docs/kubernetes/how-to/connect-to-cluster/#authenticate). + * [see here](https://docs.digitalocean.com/products/kubernetes/how-to/connect-to-cluster/#authenticate). * * @example null */ @@ -12698,6 +13004,13 @@ export interface components { */ disable_lets_encrypt_dns_records: boolean; firewall?: components["schemas"]["lb_firewall"]; + /** + * @description A string indicating whether the load balancer should be external or internal. Internal load balancers have no public IPs and are only accessible to resources on the same VPC network. This property cannot be updated after creating the load balancer. + * @default EXTERNAL + * @example EXTERNAL + * @enum {string} + */ + network: "EXTERNAL" | "INTERNAL"; }; load_balancer: components["schemas"]["load_balancer_base"] & { region?: unknown & components["schemas"]["region"]; @@ -12877,68 +13190,255 @@ export interface components { */ status: "success" | "error"; }; - project_base: { + /** @description OpenSearch destination configuration with `credentials` omitted. */ + opensearch_config_omit_credentials: { /** - * Format: uuid - * @description The unique universal identifier of this project. - * @example 4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679 + * @description A unique identifier for a configuration. + * @example 41078d41-165c-4cff-9f0a-19536e3e3d49 */ - readonly id?: string; + id?: string; /** - * @description The unique universal identifier of the project owner. - * @example 99525febec065ca37b2ffe4f852fd2b2581895e7 + * @description host of the OpenSearch cluster + * @example example.com */ - readonly owner_uuid?: string; + endpoint?: string; /** - * @description The integer id of the project owner. - * @example 258992 + * @description A unique identifier for a managed OpenSearch cluster. + * @example 85148069-7e35-4999-80bd-6fa1637ca385 */ - readonly owner_id?: number; + cluster_uuid?: string; /** - * @description The human-readable name for the project. The maximum length is 175 characters and the name must be unique. - * @example my-web-api + * @description Name of a managed OpenSearch cluster. + * @example managed_dbaas_cluster */ - name?: string; + cluster_name?: string; /** - * @description The description of the project. The maximum length is 255 characters. - * @example My website API + * @description OpenSearch index to send logs to. + * @example logs */ - description?: string; + index_name?: string; /** - * @description The purpose of the project. The maximum length is 255 characters. It can - * have one of the following values: - * - * - Just trying out DigitalOcean - * - Class project / Educational purposes - * - Website or blog - * - Web Application - * - Service or API - * - Mobile Application - * - Machine learning / AI / Data processing - * - IoT - * - Operational / Developer tooling - * - * If another value for purpose is specified, for example, "your custom purpose", - * your purpose will be stored as `Other: your custom purpose`. - * - * @example Service or API + * @description Number of days to retain logs in OpenSearch. + * @default 14 + * @example 14 */ - purpose?: string; + retention_days: number; + }; + destination_omit_credentials: { /** - * @description The environment of the project's resources. - * @example Production - * @enum {string} + * @description A unique identifier for a destination. + * @example 01f30bfa-319a-4769-ba95-9d43971fb514 */ - environment?: "Development" | "Staging" | "Production"; + id?: string; /** - * Format: date-time - * @description A time value given in ISO8601 combined date and time format that represents when the project was created. - * @example 2018-09-27T20:10:35Z + * @description destination name + * @example managed_opensearch_cluster */ - readonly created_at?: string; + name?: string; /** - * Format: date-time - * @description A time value given in ISO8601 combined date and time format that represents when the project was updated. + * @description The destination type. `opensearch_dbaas` for a DigitalOcean managed OpenSearch + * cluster or `opensearch_ext` for an externally managed one. + * + * @example opensearch_dbaas + * @enum {unknown} + */ + type?: "opensearch_dbaas" | "opensearch_ext"; + config?: components["schemas"]["opensearch_config_omit_credentials"]; + }; + opensearch_config_request: { + /** @description Credentials for an OpenSearch cluster user. Optional if `cluster_uuid` is passed. */ + credentials?: { + /** @example username */ + username?: string; + /** @example password */ + password?: string; + }; + /** + * @description host of the OpenSearch cluster + * @example example.com + */ + endpoint: string; + /** + * @description A unique identifier for a managed OpenSearch cluster. + * @example 85148069-7e35-4999-80bd-6fa1637ca385 + */ + cluster_uuid?: string; + /** + * @description Name of a managed OpenSearch cluster. + * @example managed_dbaas_cluster + */ + cluster_name?: string; + /** + * @description OpenSearch index to send logs to. + * @example logs + */ + index_name?: string; + /** + * @description Number of days to retain logs in an OpenSearch cluster. + * @default 14 + * @example 14 + */ + retention_days: number; + }; + destination_request: { + /** + * @description destination name + * @example managed_opensearch_cluster + */ + name?: string; + /** + * @description The destination type. `opensearch_dbaas` for a DigitalOcean managed OpenSearch + * cluster or `opensearch_ext` for an externally managed one. + * + * @enum {unknown} + */ + type: "opensearch_dbaas" | "opensearch_ext"; + config: components["schemas"]["opensearch_config_request"]; + }; + /** + * @description The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. + * @example do:droplet:13457723 + */ + urn: string; + opensearch_config: { + /** + * @description A unique identifier for a configuration. + * @example 41078d41-165c-4cff-9f0a-19536e3e3d49 + */ + id?: string; + /** @description Credentials for an OpenSearch cluster user. Optional if `cluster_uuid` is passed. */ + credentials?: { + /** @example username */ + username?: string; + /** @example password */ + password?: string; + }; + /** + * @description host of the OpenSearch cluster + * @example example.com + */ + endpoint: string; + /** + * @description A unique identifier for a managed OpenSearch cluster. + * @example 85148069-7e35-4999-80bd-6fa1637ca385 + */ + cluster_uuid?: string; + /** + * @description Name of a managed OpenSearch cluster. + * @example managed_dbaas_cluster + */ + cluster_name?: string; + /** + * @description OpenSearch index to send logs to. + * @example logs + */ + index_name?: string; + /** + * @description Number of days to retain logs in OpenSearch (default: 14) + * @example 14 + */ + retention_days?: number; + }; + destination: { + /** + * @description A unique identifier for a destination. + * @example 01f30bfa-319a-4769-ba95-9d43971fb514 + */ + id?: string; + /** + * @description destination name + * @example managed_opensearch_cluster + */ + name?: string; + /** + * @description The destination type. `opensearch_dbaas` for a DigitalOcean managed OpenSearch + * cluster or `opensearch_ext` for an externally managed one. + * + * @example opensearch_dbaas + * @enum {unknown} + */ + type?: "opensearch_dbaas" | "opensearch_ext"; + config: components["schemas"]["opensearch_config"]; + }; + sink_resource: { + /** + * @description The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. + * @example do:kubernetes:f453aa14-646e-4cf8-8c62-75a19fb24ec2 + */ + urn: string; + /** + * @description resource name + * @example managed_kubernetes_cluster + */ + name?: string; + }; + sinks_response: { + destination?: components["schemas"]["destination"]; + /** @description List of resources identified by their URNs. */ + resources?: components["schemas"]["sink_resource"][]; + }; + project_base: { + /** + * Format: uuid + * @description The unique universal identifier of this project. + * @example 4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679 + */ + readonly id?: string; + /** + * @description The unique universal identifier of the project owner. + * @example 99525febec065ca37b2ffe4f852fd2b2581895e7 + */ + readonly owner_uuid?: string; + /** + * @description The integer id of the project owner. + * @example 258992 + */ + readonly owner_id?: number; + /** + * @description The human-readable name for the project. The maximum length is 175 characters and the name must be unique. + * @example my-web-api + */ + name?: string; + /** + * @description The description of the project. The maximum length is 255 characters. + * @example My website API + */ + description?: string; + /** + * @description The purpose of the project. The maximum length is 255 characters. It can + * have one of the following values: + * + * - Just trying out DigitalOcean + * - Class project / Educational purposes + * - Website or blog + * - Web Application + * - Service or API + * - Mobile Application + * - Machine learning / AI / Data processing + * - IoT + * - Operational / Developer tooling + * + * If another value for purpose is specified, for example, "your custom purpose", + * your purpose will be stored as `Other: your custom purpose`. + * + * @example Service or API + */ + purpose?: string; + /** + * @description The environment of the project's resources. + * @example Production + * @enum {string} + */ + environment?: "Development" | "Staging" | "Production"; + /** + * Format: date-time + * @description A time value given in ISO8601 combined date and time format that represents when the project was created. + * @example 2018-09-27T20:10:35Z + */ + readonly created_at?: string; + /** + * Format: date-time + * @description A time value given in ISO8601 combined date and time format that represents when the project was updated. * @example 2018-09-27T20:10:35Z */ readonly updated_at?: string; @@ -12950,11 +13450,6 @@ export interface components { */ is_default?: boolean; }; - /** - * @description The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. - * @example do:droplet:13457723 - */ - urn: string; resource: { urn?: components["schemas"]["urn"]; /** @@ -13730,6 +14225,44 @@ export interface components { */ created_at?: string; }; + vpc_peering_base: { + /** + * Format: uuid + * @description A unique ID that can be used to identify and reference the VPC peering. + * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + */ + readonly id?: string; + /** + * Format: date-time + * @description A time value given in ISO8601 combined date and time format. + * @example 2020-03-13T19:20:47.442049222Z + */ + readonly created_at?: string; + /** + * @description The current status of the VPC peering. + * @example ACTIVE + * @enum {string} + */ + readonly status?: "PROVISIONING" | "ACTIVE" | "DELETING"; + }; + vpc_peering_create: { + /** + * @description An array of the two peered VPCs IDs. + * @example [ + * "c140286f-e6ce-4131-8b7b-df4590ce8d6a", + * "994a2735-dc84-11e8-80bc-3cfdfea9fba1" + * ] + */ + vpc_ids?: string[]; + }; + vpc_peering_updatable: { + /** + * @description The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes. + * @example nyc1-blr1-peering + */ + name?: string; + }; + vpc_peering: components["schemas"]["vpc_peering_base"] & components["schemas"]["vpc_peering_create"] & components["schemas"]["vpc_peering_updatable"]; check_base: { /** * Format: uuid @@ -15953,6 +16486,63 @@ export interface components { "application/json": components["schemas"]["metrics"]; }; }; + /** @description The response is a JSON object with a `destinations` key. */ + monitoring_list_destinations: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + destinations?: components["schemas"]["destination_omit_credentials"][]; + }; + }; + }; + /** @description The response is a JSON object with a `destination` key. */ + destination: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + destination?: components["schemas"]["destination_omit_credentials"]; + }; + }; + }; + /** @description The response is a JSON object with a `sinks` key. */ + list_sinks: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description List of sinks identified by their URNs. */ + sinks?: components["schemas"]["sinks_response"][]; + }; + }; + }; + /** @description The response is a JSON object with a `sink` key. */ + sinks: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + sink?: components["schemas"]["sinks_response"]; + }; + }; + }; /** @description The response will be a JSON object with a key called `projects`. The value of this will be an object with the standard project attributes */ projects_list: { headers: { @@ -16524,8 +17114,8 @@ export interface components { } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `checks`. This will be set to an array of objects, each of which will contain the standard attributes associated with an uptime check */ - all_checks: { + /** @description The response will be a JSON object with a key called `peerings`. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC peering. */ + vpc_peerings: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16534,12 +17124,12 @@ export interface components { }; content: { "application/json": { - checks?: components["schemas"]["check"][]; + peerings?: components["schemas"]["vpc_peering"][]; } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `check`. The value of this will be an object that contains the standard attributes associated with an uptime check. */ - existing_check: { + /** @description The response will be a JSON object with a key called `peering`, containing the standard attributes associated with a VPC peering. */ + vpc_peering: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16548,12 +17138,12 @@ export interface components { }; content: { "application/json": { - check?: components["schemas"]["check"]; + peering?: components["schemas"]["vpc_peering"]; }; }; }; - /** @description The response will be a JSON object with a key called `state`. The value of this will be an object that contains the standard attributes associated with an uptime check's state. */ - existing_check_state: { + /** @description The response will be a JSON object with a key called `vpc_peerings`. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC peering. */ + all_vpc_peerings: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16562,12 +17152,26 @@ export interface components { }; content: { "application/json": { - state?: components["schemas"]["state"]; + vpc_peerings?: components["schemas"]["vpc_peering"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `vpc_peering`. The value of this will be an object that contains the standard attributes associated with a VPC peering. */ + provisioning_vpc_peering: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + vpc_peering?: components["schemas"]["vpc_peering"]; }; }; }; - /** @description The response will be a JSON object with a key called `alerts`. This will be set to an array of objects, each of which will contain the standard attributes associated with an uptime alert. */ - all_alerts: { + /** @description The response will be a JSON object with a key called `vpc_peering`. The value of this will be an object that contains the standard attributes associated with a VPC peering. */ + active_vpc_peering: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16576,12 +17180,12 @@ export interface components { }; content: { "application/json": { - alerts?: components["schemas"]["alert"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + vpc_peering?: components["schemas"]["vpc_peering"]; + }; }; }; - /** @description The response will be a JSON object with a key called `alert`. The value of this will be an object that contains the standard attributes associated with an uptime alert. */ - existing_alert: { + /** @description The response will be a JSON object with a key called `vpc_peering`. The value of this will be an object that contains the standard attributes associated with a VPC peering. */ + deleting_vpc_peering: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16590,28 +17194,98 @@ export interface components { }; content: { "application/json": { - alert?: components["schemas"]["alert"]; + vpc_peering?: components["schemas"]["vpc_peering"]; }; }; }; - }; - parameters: { - /** - * @description Restrict results to a certain type of 1-Click. - * @example kubernetes - */ - oneClicks_type: "droplet" | "kubernetes"; - /** - * @description Number of items returned per page - * @example 2 - */ - per_page: number; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page: number; - /** + /** @description The response will be a JSON object with a key called `checks`. This will be set to an array of objects, each of which will contain the standard attributes associated with an uptime check */ + all_checks: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + checks?: components["schemas"]["check"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `check`. The value of this will be an object that contains the standard attributes associated with an uptime check. */ + existing_check: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + check?: components["schemas"]["check"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `state`. The value of this will be an object that contains the standard attributes associated with an uptime check's state. */ + existing_check_state: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + state?: components["schemas"]["state"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `alerts`. This will be set to an array of objects, each of which will contain the standard attributes associated with an uptime alert. */ + all_alerts: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + alerts?: components["schemas"]["alert"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `alert`. The value of this will be an object that contains the standard attributes associated with an uptime alert. */ + existing_alert: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + alert?: components["schemas"]["alert"]; + }; + }; + }; + }; + parameters: { + /** + * @description Restrict results to a certain type of 1-Click. + * @example kubernetes + */ + oneClicks_type: "droplet" | "kubernetes"; + /** + * @description Number of items returned per page + * @example 2 + */ + per_page: number; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page: number; + /** * @description Either the ID or the fingerprint of an existing SSH key. * @example 512189 */ @@ -16781,7 +17455,7 @@ export interface components { */ domain_record_id: number; /** - * @description Used to filter Droplets by a specific tag. Can not be combined with `name`. + * @description Used to filter Droplets by a specific tag. Can not be combined with `name` or `type`. * @example env:prod */ droplet_tag_name: string; @@ -16790,6 +17464,11 @@ export interface components { * @example web-01 */ droplet_name: string; + /** + * @description When `type` is set to `gpus`, only GPU Droplets will be returned. By default, only non-GPU Droplets are returned. Can not be combined with `tag_name`. + * @example droplets + */ + droplet_type: "droplets" | "gpus"; /** * @description Specifies Droplets to be deleted by tag. * @example env:test @@ -16930,6 +17609,21 @@ export interface components { * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ parameters_load_balancer_id: string; + /** + * @description A unique identifier for a destination. + * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 + */ + destination_uuid: string; + /** + * @description A unique URN for a resource. + * @example do:kubernetes:5ba4518b-b9e2-4978-aa92-2d4c727e8824 + */ + resource_id: components["schemas"]["urn"]; + /** + * @description A unique identifier for a sink. + * @example 78b172b6-52c3-4a4b-96d5-78d3f1a0b18c + */ + sink_uuid: string; /** * @description A unique identifier for a project. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 @@ -17030,6 +17724,11 @@ export interface components { * @example droplet */ vpc_resource_type: string; + /** + * @description A unique identifier for a VPC peering. + * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + */ + vpc_peering_id: string; /** * @description A unique identifier for a check. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 @@ -18409,7 +19108,18 @@ export interface operations { }; invoices_get_byUUID: { parameters: { - query?: never; + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; header?: never; path: { /** @@ -20456,7 +21166,7 @@ export interface operations { */ page?: components["parameters"]["page"]; /** - * @description Used to filter Droplets by a specific tag. Can not be combined with `name`. + * @description Used to filter Droplets by a specific tag. Can not be combined with `name` or `type`. * @example env:prod */ tag_name?: components["parameters"]["droplet_tag_name"]; @@ -20465,6 +21175,11 @@ export interface operations { * @example web-01 */ name?: components["parameters"]["droplet_name"]; + /** + * @description When `type` is set to `gpus`, only GPU Droplets will be returned. By default, only non-GPU Droplets are returned. Can not be combined with `tag_name`. + * @example droplets + */ + type?: components["parameters"]["droplet_type"]; }; header?: never; path?: never; @@ -20773,7 +21488,7 @@ export interface operations { parameters: { query?: { /** - * @description Used to filter Droplets by a specific tag. Can not be combined with `name`. + * @description Used to filter Droplets by a specific tag. Can not be combined with `name` or `type`. * @example env:prod */ tag_name?: components["parameters"]["droplet_tag_name"]; @@ -23099,7 +23814,7 @@ export interface operations { * `v1/insights/lbaas/avg_cpu_utilization_percent`|alert on the percent of CPU utilization|load balancer ID * `v1/insights/lbaas/connection_utilization_percent`|alert on the percent of connection utilization|load balancer ID * `v1/insights/lbaas/droplet_health`|alert on Droplet health status changes|load balancer ID - * `v1/insights/lbaas/tls_connections_per_second_utilization_percent`|alert on the percent of TLS connections per second utilization|load balancer ID + * `v1/insights/lbaas/tls_connections_per_second_utilization_percent`|alert on the percent of TLS connections per second utilization (requires at least one HTTPS forwarding rule)|load balancer ID * `v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx`|alert on the percent increase of 5xx level http errors over 5m|load balancer ID * `v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx`|alert on the percent increase of 4xx level http errors over 5m|load balancer ID * `v1/insights/lbaas/increase_in_http_error_rate_count_5xx`|alert on the count of 5xx level http errors over 5m|load balancer ID @@ -23181,7 +23896,7 @@ export interface operations { * `v1/insights/lbaas/avg_cpu_utilization_percent`|alert on the percent of CPU utilization|load balancer ID * `v1/insights/lbaas/connection_utilization_percent`|alert on the percent of connection utilization|load balancer ID * `v1/insights/lbaas/droplet_health`|alert on Droplet health status changes|load balancer ID - * `v1/insights/lbaas/tls_connections_per_second_utilization_percent`|alert on the percent of TLS connections per second utilization|load balancer ID + * `v1/insights/lbaas/tls_connections_per_second_utilization_percent`|alert on the percent of TLS connections per second utilization (requires at least one HTTPS forwarding rule)|load balancer ID * `v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx`|alert on the percent increase of 5xx level http errors over 5m|load balancer ID * `v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx`|alert on the percent increase of 4xx level http errors over 5m|load balancer ID * `v1/insights/lbaas/increase_in_http_error_rate_count_5xx`|alert on the count of 5xx level http errors over 5m|load balancer ID @@ -24569,6 +25284,215 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; + monitoring_list_destinations: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["monitoring_list_destinations"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_create_destination: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["destination_request"]; + }; + }; + responses: { + 200: components["responses"]["destination"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_get_destination: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a destination. + * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 + */ + destination_uuid: components["parameters"]["destination_uuid"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["destination"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_update_destination: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a destination. + * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 + */ + destination_uuid: components["parameters"]["destination_uuid"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["destination_request"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_delete_destination: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a destination. + * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 + */ + destination_uuid: components["parameters"]["destination_uuid"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_list_sinks: { + parameters: { + query?: { + /** + * @description A unique URN for a resource. + * @example do:kubernetes:5ba4518b-b9e2-4978-aa92-2d4c727e8824 + */ + resource_id?: components["parameters"]["resource_id"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["list_sinks"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_create_sink: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description A unique identifier for an already-existing destination. + * @example 9df2b7e9-3fb2-4577-b60a-e9c0d53f9a99 + */ + destination_uuid?: string; + /** @description List of resources identified by their URNs. */ + resources?: components["schemas"]["sink_resource"][]; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_get_sink: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a sink. + * @example 78b172b6-52c3-4a4b-96d5-78d3f1a0b18c + */ + sink_uuid: components["parameters"]["sink_uuid"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["sinks"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_delete_sink: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a sink. + * @example 78b172b6-52c3-4a4b-96d5-78d3f1a0b18c + */ + sink_uuid: components["parameters"]["sink_uuid"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; projects_list: { parameters: { query?: { @@ -26425,6 +27349,237 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; + vpcs_list_peerings: { + parameters: { + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** + * @description A unique identifier for a VPC. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + vpc_id: components["parameters"]["vpc_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["vpc_peerings"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + vpcs_create_peerings: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a VPC. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + vpc_id: components["parameters"]["vpc_id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The name of the VPC peering. Must be unique and may only contain alphanumeric characters, dashes, and periods. + * @example nyc1-blr1-peering + */ + name: string; + /** + * Format: uuid + * @description The ID of the VPC to peer with. + * @example c140286f-e6ce-4131-8b7b-df4590ce8d6a + */ + vpc_id: string; + }; + }; + }; + responses: { + 202: components["responses"]["vpc_peering"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + vpcs_patch_peerings: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a VPC. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + vpc_id: components["parameters"]["vpc_id"]; + /** + * @description A unique identifier for a VPC peering. + * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + */ + vpc_peering_id: components["parameters"]["vpc_peering_id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": WithRequired; + }; + }; + responses: { + 200: components["responses"]["vpc_peering"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + vpcPeerings_list: { + parameters: { + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + /** + * @description The slug identifier for the region where the resource is available. + * @example nyc3 + */ + region?: components["parameters"]["region"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["all_vpc_peerings"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + vpcPeerings_create: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": WithRequired & WithRequired; + }; + }; + responses: { + 202: components["responses"]["provisioning_vpc_peering"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + vpcPeerings_get: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a VPC peering. + * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + */ + vpc_peering_id: components["parameters"]["vpc_peering_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["active_vpc_peering"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + vpcPeerings_delete: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a VPC peering. + * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + */ + vpc_peering_id: components["parameters"]["vpc_peering_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["deleting_vpc_peering"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + vpcPeerings_patch: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a VPC peering. + * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + */ + vpc_peering_id: components["parameters"]["vpc_peering_id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": WithRequired; + }; + }; + responses: { + 200: components["responses"]["active_vpc_peering"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; uptime_list_checks: { parameters: { query?: { diff --git a/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml b/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml index 3b95f9380..ff8df2f42 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml +++ b/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml @@ -23,7 +23,7 @@ tags: description: |- 1-Click applications are pre-built Droplet images or Kubernetes apps with software, features, and configuration details already set up for you. They can be found in the - [DigitalOcean Marketplace](https://www.digitalocean.com/docs/marketplace). + [DigitalOcean Marketplace](https://marketplace.digitalocean.com/). - name: Account description: Provides information about your current account. @@ -66,7 +66,7 @@ tags: **Balance:** By sending requests to the `/v2/customers/my/balance` endpoint, you can retrieve the balance information for the requested customer account. - **Invoices:** [Invoices](https://www.digitalocean.com/docs/accounts/billing/invoices/) + **Invoices:** [Invoices](https://docs.digitalocean.com/platform/billing/invoices/) are generated on the first of each month for every DigitalOcean customer. An invoice preview is generated daily, which can be accessed with the `preview` keyword in place of `$INVOICE_UUID`. To interact with @@ -81,7 +81,7 @@ tags: - name: Block Storage description: |- - [DigitalOcean Block Storage Volumes](https://www.digitalocean.com/docs/volumes/) + [DigitalOcean Block Storage Volumes](https://docs.digitalocean.com/products/volumes/) provide expanded storage capacity for your Droplets and can be moved between Droplets within a specific region. @@ -106,18 +106,20 @@ tags: - name: CDN Endpoints description: |- Content hosted in DigitalOcean's object storage solution, - [Spaces](https://www.digitalocean.com/docs/spaces/overview/), + [Spaces](https://docs.digitalocean.com/products/spaces/), can optionally be served by our globally distributed Content Delivery Network (CDN). By sending requests to `/v2/cdn/endpoints`, you can list, create, or delete CDN Endpoints as well as purge cached content. To use a custom subdomain to access the CDN Endpoint, provide the ID of a DigitalOcean managed TLS certificate and the fully qualified domain name - for the custom subdomain. + for the custom subdomain. + + CDN endpoints have a rate limit of five requests per 10 seconds. - name: Certificates description: |- In order to perform SSL termination on load balancers, DigitalOcean offers - two types of [SSL certificate management](https://www.digitalocean.com/docs/accounts/security/#certificates): + two types of [SSL certificate management](https://docs.digitalocean.com/platform/teams/manage-certificates): * **Custom**: User-generated certificates may be uploaded to DigitalOcean where they will be placed in a fully encrypted and isolated storage system. @@ -130,7 +132,7 @@ tags: - name: Container Registry description: |- DigitalOcean offers the ability for you to create a - [private container registry](https://www.digitalocean.com/docs/images/container-registry/quickstart/) + [private container registry](https://docs.digitalocean.com/products/container-registry/) to store your Docker images for use with your Kubernetes clusters. This container registry runs inside the same datacenters as your cluster, ensuring reliable and performant rollout of image deployments. @@ -140,12 +142,12 @@ tags: - name: Databases description: |- - DigitalOcean's [managed database service](https://www.digitalocean.com/docs/databases) + DigitalOcean's [managed database service](https://docs.digitalocean.com/products/databases) simplifies the creation and management of highly available database clusters. Currently, it - offers support for [PostgreSQL](http://www.digitalocean.com/docs/databases/postgresql/), - [Redis](https://www.digitalocean.com/docs/databases/redis/), - [MySQL](https://www.digitalocean.com/docs/databases/mysql/), - [MongoDB](https://www.digitalocean.com/docs/databases/mongodb/), and + offers support for [PostgreSQL](http://docs.digitalocean.com/products/databases/postgresql/), + [Redis](https://docs.digitalocean.com/products/databases/redis/), + [MySQL](https://docs.digitalocean.com/products/databases/mysql/), + [MongoDB](https://docs.digitalocean.com/products/databases/mongodb/), and [OpenSearch](https://docs.digitalocean.com/products/databases/opensearch/). By sending requests to the `/v2/databases` endpoint, you can list, create, or delete @@ -170,7 +172,7 @@ tags: and manage DNS zone files by adding and modifying individual records for a domain. - The [DigitalOcean DNS management interface](https://www.digitalocean.com/docs/networking/dns/) + The [DigitalOcean DNS management interface](https://docs.digitalocean.com/products/networking/dns/) allows you to configure the following DNS records: Name | Description | @@ -189,7 +191,7 @@ tags: description: |- Domain resources are domain names that you have purchased from a domain name registrar that you are managing through the - [DigitalOcean DNS interface](https://www.digitalocean.com/docs/networking/dns/). + [DigitalOcean DNS interface](https://docs.digitalocean.com/products/networking/dns/). This resource establishes top-level control over each domain. Actions that affect individual domain records should be taken on the @@ -217,7 +219,7 @@ tags: - name: Droplets description: |- - A [Droplet](https://www.digitalocean.com/docs/droplets/) is a DigitalOcean + A [Droplet](https://docs.digitalocean.com/products/droplets/) is a DigitalOcean virtual machine. By sending requests to the Droplet endpoint, you can list, create, or delete Droplets. @@ -228,7 +230,7 @@ tags: - name: Firewalls description: |- - [DigitalOcean Cloud Firewalls](https://www.digitalocean.com/docs/networking/firewalls/) + [DigitalOcean Cloud Firewalls](https://docs.digitalocean.com/products/networking/firewalls/) provide the ability to restrict network access to and from a Droplet allowing you to define which ports will accept inbound or outbound connections. By sending requests to the `/v2/firewalls` endpoint, you can @@ -271,7 +273,7 @@ tags: will contain the field `reserved_ips` in addition to the `floating_ips` field. Floating IPs retrieved using the Projects API will retain the original name. - [DigitalOcean Floating IPs](https://www.digitalocean.com/docs/networking/floating-ips/) + [DigitalOcean Floating IPs](https://docs.digitalocean.com/products/networking/reserved-ips/) are publicly-accessible static IP addresses that can be mapped to one of your Droplets. They can be used to create highly available setups or other configurations requiring movable addresses. @@ -296,26 +298,26 @@ tags: - name: Images description: |- - A DigitalOcean [image](https://www.digitalocean.com/docs/images/) can be + A DigitalOcean [image](https://docs.digitalocean.com/products/images/) can be used to create a Droplet and may come in a number of flavors. Currently, there are five types of images: snapshots, backups, applications, distributions, and custom images. - * [Snapshots](https://www.digitalocean.com/docs/images/snapshots/) provide + * [Snapshots](https://docs.digitalocean.com/products/snapshots/) provide a full copy of an existing Droplet instance taken on demand. - * [Backups](https://www.digitalocean.com/docs/images/backups/) are similar + * [Backups](https://docs.digitalocean.com/products/backups/) are similar to snapshots but are created automatically at regular intervals when enabled for a Droplet. - * [Custom images](https://www.digitalocean.com/docs/images/custom-images/) + * [Custom images](https://docs.digitalocean.com/products/custom-images/) are Linux-based virtual machine images (raw, qcow2, vhdx, vdi, and vmdk formats are supported) that you may upload for use on DigitalOcean. * Distributions are the public Linux distributions that are available to be used as a base to create Droplets. - * Applications, or [1-Click Apps](https://www.digitalocean.com/docs/one-clicks/), + * Applications, or [1-Click Apps](https://docs.digitalocean.com/products/marketplace/), are distributions pre-configured with additional software. To interact with images, you will generally send requests to the images @@ -323,7 +325,7 @@ tags: - name: Kubernetes description: |- - [DigitalOcean Kubernetes](https://www.digitalocean.com/docs/kubernetes/) + [DigitalOcean Kubernetes](https://docs.digitalocean.com/products/kubernetes/) allows you to quickly deploy scalable and secure Kubernetes clusters. By sending requests to the `/v2/kubernetes/clusters` endpoint, you can list, create, or delete clusters as well as scale node pools up and down, @@ -332,7 +334,7 @@ tags: - name: Load Balancers description: |- - [DigitalOcean Load Balancers](https://www.digitalocean.com/docs/networking/load-balancers/) + [DigitalOcean Load Balancers](https://docs.digitalocean.com/products/networking/load-balancers/) provide a way to distribute traffic across multiple Droplets. By sending requests to the `/v2/load_balancers` endpoint, you can list, create, or delete load balancers as well as add or remove Droplets, forwarding rules, @@ -449,7 +451,7 @@ tags: - name: Snapshots description: |- - [Snapshots](https://www.digitalocean.com/docs/images/snapshots/) are saved + [Snapshots](https://docs.digitalocean.com/products/snapshots/) are saved instances of a Droplet or a block storage volume, which is reflected in the `resource_type` attribute. In order to avoid problems with compressing filesystems, each defines a `min_disk_size` attribute which is the minimum @@ -478,9 +480,16 @@ tags: To interact with Uptime, you will generally send requests to the Uptime endpoint at `/v2/uptime/`. + - name: VPC Peerings + description: |- + [VPC Peerings](https://docs.digitalocean.com/products/networking/vpc/how-to/create-peering/) + join two VPC networks with a secure, private connection. This allows + resources in those networks to connect to each other's private IP addresses + as if they were in the same network. + - name: VPCs description: |- - [VPCs (virtual private clouds)](https://www.digitalocean.com/docs/networking/vpc/) + [VPCs (virtual private clouds)](https://docs.digitalocean.com/products/networking/vpc/) allow you to create virtual networks containing resources that can communicate with each other in full isolation using private IP addresses. @@ -1393,6 +1402,32 @@ paths: get: $ref: 'resources/monitoring/monitoring_get_lb_droplets_downtime.yml' + /v2/monitoring/sinks/destinations: + post: + $ref: 'resources/monitoring/monitoring_create_destination.yml' + get: + $ref: 'resources/monitoring/monitoring_list_destinations.yml' + + /v2/monitoring/sinks/destinations/{destination_uuid}: + get: + $ref: 'resources/monitoring/monitoring_get_destination.yml' + post: + $ref: 'resources/monitoring/monitoring_update_destination.yml' + delete: + $ref: 'resources/monitoring/monitoring_delete_destination.yml' + + /v2/monitoring/sinks: + post: + $ref: 'resources/monitoring/monitoring_create_sink.yml' + get: + $ref: 'resources/monitoring/monitoring_list_sinks.yml' + + /v2/monitoring/sinks/{sink_uuid}: + get: + $ref: 'resources/monitoring/monitoring_get_sink.yml' + delete: + $ref: 'resources/monitoring/monitoring_delete_sink.yml' + /v2/projects: get: $ref: 'resources/projects/projects_list.yml' @@ -1635,6 +1670,33 @@ paths: get: $ref: 'resources/vpcs/vpcs_list_members.yml' + /v2/vpcs/{vpc_id}/peerings: + get: + $ref: 'resources/vpcs/vpcs_list_peerings.yml' + + post: + $ref: 'resources/vpcs/vpcs_create_peerings.yml' + + /v2/vpcs/{vpc_id}/peerings/{vpc_peering_id}: + patch: + $ref: 'resources/vpcs/vpcs_update_peerings.yml' + + /v2/vpc_peerings: + get: + $ref: 'resources/vpc_peerings/vpc_peerings_list.yml' + + post: + $ref: 'resources/vpc_peerings/vpc_peerings_create.yml' + + /v2/vpc_peerings/{vpc_peering_id}: + get: + $ref: 'resources/vpc_peerings/vpc_peerings_get.yml' + + patch: + $ref: 'resources/vpc_peerings/vpc_peerings_update.yml' + + delete: + $ref: 'resources/vpc_peerings/vpc_peerings_delete.yml' /v2/uptime/checks: get: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/models/action.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/models/action.yml index 71e3a7700..258622294 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/models/action.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/models/action.yml @@ -49,7 +49,8 @@ properties: $ref: '../../regions/models/region.yml' region_slug: - allOf: - - $ref: '../../regions/models/region.yml#/properties/slug' - - type: string - nullable: true \ No newline at end of file + type: string + nullable: true + description: A human-readable string that is used as a unique identifier + for each region. + example: nyc3 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_base.yml index ab973c885..99230a789 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_base.yml @@ -55,7 +55,7 @@ properties: environment_slug: type: string description: An environment slug describing the type of this app. For a full list, - please refer to [the product documentation](https://www.digitalocean.com/docs/app-platform/). + please refer to [the product documentation](https://docs.digitalocean.com/products/app-platform/). example: node-js log_destinations: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_instance_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_instance_base.yml index b882c0f89..541bbdbf4 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_instance_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_instance_base.yml @@ -5,31 +5,52 @@ properties: type: integer format: int64 minimum: 1 - description: 'The amount of instances that this component should be scaled to. Default: 1. Must not be set if autoscaling is used.' + description: "The amount of instances that this component should be scaled to. Default: 1. Must not be set if autoscaling is used." default: 1 example: 2 instance_size_slug: - description: 'The instance size to use for this component. Default: `apps-s-1vcpu-0.5gb`' - type: string - enum: - - apps-s-1vcpu-0.5gb - - apps-s-1vcpu-1gb-fixed - - apps-s-1vcpu-1gb - - apps-s-1vcpu-2gb - - apps-s-2vcpu-4gb - - apps-d-1vcpu-0.5gb - - apps-d-1vcpu-1gb - - apps-d-1vcpu-2gb - - apps-d-1vcpu-4gb - - apps-d-2vcpu-4gb - - apps-d-2vcpu-8gb - - apps-d-4vcpu-8gb - - apps-d-4vcpu-16gb - - apps-d-8vcpu-32gb - default: apps-s-1vcpu-0.5gb + description: "The instance size to use for this component. Default: `apps-s-1vcpu-0.5gb`" + oneOf: + - title: "Size slug" + type: string + enum: + - apps-s-1vcpu-0.5gb + - apps-s-1vcpu-1gb-fixed + - apps-s-1vcpu-1gb + - apps-s-1vcpu-2gb + - apps-s-2vcpu-4gb + - apps-d-1vcpu-0.5gb + - apps-d-1vcpu-1gb + - apps-d-1vcpu-2gb + - apps-d-1vcpu-4gb + - apps-d-2vcpu-4gb + - apps-d-2vcpu-8gb + - apps-d-4vcpu-8gb + - apps-d-4vcpu-16gb + - apps-d-8vcpu-32gb + default: apps-s-1vcpu-0.5gb + example: apps-s-1vcpu-0.5gb + - title: "Deprecated" + description: | + Deprecated size slugs for legacy plans. We strongly encourage customers + to use the new plans when creating or upgrading apps. + type: string + enum: + - basic-xxs + - basic-xs + - basic-s + - basic-m + - professional-xs + - professional-s + - professional-m + - professional-1l + - professional-l + - professional-xl + example: basic-xxs + deprecated: true example: apps-s-1vcpu-0.5gb - + autoscaling: description: Configuration for automatically scaling this component based on metrics. type: object @@ -61,4 +82,4 @@ properties: minimum: 1 maximum: 100 default: 80 - example: 75 \ No newline at end of file + example: 75 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_maintenance_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_maintenance_spec.yml new file mode 100644 index 000000000..2c8a92304 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_maintenance_spec.yml @@ -0,0 +1,11 @@ +type: object +description: Specification to configure maintenance settings for the app, such as maintenance mode and archiving the app. +properties: + enabled: + type: boolean + description: Indicates whether maintenance mode should be enabled for the app. + example: true + archive: + type: boolean + description: Indicates whether the app should be archived. Setting this to true implies that enabled is set to true. Note that this feature is currently in closed beta. + example: true diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_service_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_service_spec.yml index 73bb70b73..c91d26469 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_service_spec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_service_spec.yml @@ -13,6 +13,18 @@ allOf: health_check: $ref: app_service_spec_health_check.yml + protocol: + type: string + description: | + The protocol which the service uses to serve traffic on the http_port. + + - `HTTP`: The app is serving the HTTP protocol. Default. + - `HTTP2`: The app is serving the HTTP/2 protocol. Currently, this needs to be implemented in the service by serving HTTP/2 cleartext (h2c). + enum: + - HTTP + - HTTP2 + example: HTTP + http_port: type: integer description: |- diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_spec.yml index 97675a63e..07a38ba19 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_spec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_spec.yml @@ -77,5 +77,8 @@ properties: egress: $ref: app_egress_spec.yml + maintenance: + $ref: app_maintenance_spec.yml + required: - name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_byUUID.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_byUUID.yml index 354165834..650467a5a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_byUUID.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_byUUID.yml @@ -11,6 +11,8 @@ tags: parameters: - $ref: 'parameters.yml#/invoice_uuid' + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' responses: '200': diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_purge_cache.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_purge_cache.yml index 058322535..c80c180f9 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_purge_cache.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_purge_cache.yml @@ -7,9 +7,11 @@ description: | `/v2/cdn/endpoints/$ENDPOINT_ID/cache`. The body of the request should include a `files` attribute containing a list of cached file paths to be purged. A path may be for a single file or may contain a wildcard (`*`) to recursively - purge all files under a directory. When only a wildcard is provided, all - cached files will be purged. There is a rate limit of 50 files per 20 seconds - that can be purged. + purge all files under a directory. When only a wildcard is provided, all cached + files will be purged. There is a rate limit of 50 files per 20 seconds that can + be purged. CDN endpoints have a rate limit of 5 requests per 10 seconds. + Purging files using a wildcard path counts as a single request against the API's + rate limit. Two identical purge requests cannot be sent at the same time. tags: - CDN Endpoints diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_get.yml index 94c98ef7a..1f9d8059e 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_get.yml @@ -39,5 +39,5 @@ x-codeSamples: security: - bearer_auth: - - 'cdn:read' + - 'certificate:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_list.yml index 5ca386d4c..3914fa7a3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_list.yml @@ -38,4 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'cdn:read' + - 'certificate:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_connectionPool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_connectionPool.yml index c2500da3a..7b31f54ad 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_connectionPool.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_connectionPool.yml @@ -5,7 +5,7 @@ summary: Add a New Connection Pool (PostgreSQL) description: | For PostgreSQL database clusters, connection pools can be used to allow a database to share its idle connections. The popular PostgreSQL connection - pooling utility PgBouncer is used to provide this service. [See here for more information](https://www.digitalocean.com/docs/databases/postgresql/how-to/manage-connection-pools/) + pooling utility PgBouncer is used to provide this service. [See here for more information](https://docs.digitalocean.com/products/databases/postgresql/how-to/manage-connection-pools/) about how and why to use PgBouncer connection pooling including details about the available transaction modes. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_firewall_rules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_firewall_rules.yml index 5661f2f6a..6b6125fe5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_firewall_rules.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_firewall_rules.yml @@ -11,7 +11,7 @@ description: >- provided, any Droplet or Kubernetes node with that tag applied to it will have access. The firewall is limited to 100 rules (or trusted sources). When possible, we recommend - [placing your databases into a VPC network](https://www.digitalocean.com/docs/networking/vpc/) + [placing your databases into a VPC network](https://docs.digitalocean.com/products/networking/vpc/) to limit access to them instead of using a firewall. A successful diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/opensearch_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/opensearch_advanced_config.yml index b72e7b1de..1fe6c867d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/opensearch_advanced_config.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/opensearch_advanced_config.yml @@ -205,7 +205,7 @@ properties: type: integer example: 2500000 minimum: 1 - maximum: 9223372036854776000 + maximum: 9223372036854775807 default: 2500000 ism_history_rollover_check_period_hours: description: >- @@ -269,7 +269,7 @@ properties: default: use-context cluster_routing_allocation_node_concurrent_recoveries: description: >- - Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node . + Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node . type: integer example: 2 minimum: 2 @@ -279,6 +279,12 @@ properties: description: >- Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart. type: array - items: + items: type: string - example: ["255.255.223.233:9200", "222.33.222.222:6300"] \ No newline at end of file + example: ["255.255.223.233:9200", "222.33.222.222:6300"] + plugins_alerting_filter_by_backend_roles_enabled: + description: >- + Enable or disable filtering of alerting by backend roles. + type: boolean + example: false + default: false diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/postgres_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/postgres_advanced_config.yml index dc77b86cc..c2c806586 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/postgres_advanced_config.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/postgres_advanced_config.yml @@ -407,3 +407,10 @@ properties: Enable the pg_stat_monitor extension. Enabling this extension will cause the cluster to be restarted. When this extension is enabled, pg_stat_statements results for utility commands are unreliable. type: boolean example: false + max_failover_replication_time_lag: + description: >- + Number of seconds of master unavailability before triggering database failover to standby. The default value is 60. + type: integer + minimum: 10 + maximum: 9223372036854776000 + example: 50 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/redis_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/redis_advanced_config.yml index 9e418eb60..ed24a02c3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/redis_advanced_config.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/redis_advanced_config.yml @@ -2,7 +2,7 @@ type: object properties: redis_maxmemory_policy: - $ref: '../eviction_policy_model.yml' + $ref: "../eviction_policy_model.yml" redis_pubsub_client_output_buffer_limit: description: >- Set output buffer limit for pub / sub clients in MB. The value is the hard @@ -43,7 +43,10 @@ properties: default: 1 example: 1 redis_ssl: - description: Require SSL to access Redis + description: | + Require SSL to access Redis. + - When enabled, Redis accepts only SSL connections on port `25061`. + - When disabled, port `25060` is opened for non-SSL connections, while port `25061` remains available for SSL connections. type: boolean default: true example: true @@ -74,13 +77,13 @@ properties: - `A` — Alias for `"g$lshztxed"` type: string pattern: ^[KEg\$lshzxeA]*$ - default: '' + default: "" maxLength: 32 example: K redis_persistence: type: string enum: - - 'off' + - "off" - rdb description: >- When persistence is 'rdb', Redis does RDB dumps each 10 minutes if any key diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_destroyAssociatedResourcesStatus.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_destroyAssociatedResourcesStatus.yml index 72b7fdde0..69e4496f9 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_destroyAssociatedResourcesStatus.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_destroyAssociatedResourcesStatus.yml @@ -38,4 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'droplet:read' + - 'droplet:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list.yml index 5d37ed30c..9b700e109 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list.yml @@ -16,6 +16,11 @@ description: | parameter set to the name of the tag in your GET request. For example, `/v2/droplets?tag_name=$TAG_NAME`. + ### GPU Droplets + + By default, only non-GPU Droplets are returned. To list only GPU Droplets, set + the `type` query parameter to `gpus`. For example, `/v2/droplets?type=gpus`. + tags: - Droplets @@ -24,6 +29,7 @@ parameters: - $ref: '../../shared/parameters.yml#/page' - $ref: 'parameters.yml#/droplet_tag_name' - $ref: 'parameters.yml#/droplet_name' + - $ref: 'parameters.yml#/droplet_type' responses: '200': diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_associatedResources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_associatedResources.yml index 8419a1cce..1c057f2e2 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_associatedResources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_associatedResources.yml @@ -42,4 +42,4 @@ x-codeSamples: security: - bearer_auth: - - 'droplet:read' + - 'droplet:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet.yml index 778e0acf2..ce7460f4b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet.yml @@ -28,6 +28,13 @@ properties: example: 25 description: The size of the Droplet's disk in gigabytes. + disk_info: + type: array + description: An array of objects containing information about the disks + available to the Droplet. + items: + $ref: '../../sizes/models/disk_info.yml' + locked: type: boolean example: false @@ -147,6 +154,9 @@ properties: description: A string specifying the UUID of the VPC to which the Droplet is assigned. + gpu_info: + $ref: '../../sizes/models/gpu_info.yml' + required: - id - name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_actions.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_actions.yml index 19e895d19..f106a5c97 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_actions.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_actions.yml @@ -34,7 +34,7 @@ droplet_action_enable_backups: allOf: - $ref: 'droplet_backup_policy.yml' - description: An object specifying the backup policy for the Droplet. If - omitted, the default backup policy will be used. + omitted, the backup plan will default to daily. example: type: enable_backups diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_create.yml index 637217044..b4ffb6032 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_create.yml @@ -49,7 +49,7 @@ properties: allOf: - $ref: 'droplet_backup_policy.yml' - description: An object specifying the backup policy for the Droplet. If - omitted and `backups` is `true`, the default backup policy will be used. + omitted and `backups` is `true`, the backup plan will default to daily. ipv6: type: boolean diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/kernel.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/kernel.yml index 58b19a0ab..08e6aa587 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/kernel.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/kernel.yml @@ -4,7 +4,7 @@ description: | **Note**: All Droplets created after March 2017 use internal kernels by default. These Droplets will have this attribute set to `null`. - The current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/) + The current [kernel](https://docs.digitalocean.com/products/droplets/how-to/kernel/) for Droplets with externally managed kernels. This will initially be set to the kernel of the base image when the Droplet is created. @@ -28,4 +28,4 @@ properties: type: string example: 2016.07.13-DigitalOcean_loader_Ubuntu description: A standard kernel version string representing the version, - patch, and release information. \ No newline at end of file + patch, and release information. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/parameters.yml index 77cb72d66..80ea30561 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/parameters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/parameters.yml @@ -12,12 +12,26 @@ droplet_tag_name: in: query name: tag_name description: Used to filter Droplets by a specific tag. Can not be combined - with `name`. + with `name` or `type`. required: false schema: type: string example: env:prod +droplet_type: + in: query + name: type + description: When `type` is set to `gpus`, only GPU Droplets will be returned. + By default, only non-GPU Droplets are returned. Can not be combined with + `tag_name`. + required: false + schema: + type: string + enum: + - droplets + - gpus + example: droplets + droplet_delete_tag_name: in: query name: tag_name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/all_droplets.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/all_droplets.yml index bfc3799ec..6f987c588 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/all_droplets.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/all_droplets.yml @@ -25,3 +25,5 @@ content: $ref: 'examples.yml#/droplets_all' Droplets Filtered By Tag: $ref: 'examples.yml#/droplets_tagged' + GPU Droplets: + $ref: 'examples.yml#/gpu_droplets' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/examples.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/examples.yml index 447c26ce2..c0d40eea9 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/examples.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/examples.yml @@ -6,6 +6,11 @@ droplets_all: memory: 1024 vcpus: 1 disk: 25 + disk_info: + - type: "local" + size: + amount: 25 + unit: "gib" locked: false status: active kernel: null @@ -126,6 +131,11 @@ droplets_all: memory: 1024 vcpus: 1 disk: 25 + disk_info: + - type: "local" + size: + amount: 25 + unit: "gib" locked: false status: active kernel: null @@ -239,6 +249,11 @@ droplets_all: memory: 1024 vcpus: 1 disk: 25 + disk_info: + - type: "local" + size: + amount: 25 + unit: "gib" locked: false status: active kernel: null @@ -360,6 +375,11 @@ droplets_tagged: memory: 1024 vcpus: 1 disk: 25 + disk_info: + - type: "local" + size: + amount: 25 + unit: "gib" locked: false status: active kernel: null @@ -480,6 +500,11 @@ droplets_tagged: memory: 1024 vcpus: 1 disk: 25 + disk_info: + - type: "local" + size: + amount: 25 + unit: "gib" locked: false status: active kernel: null @@ -594,6 +619,143 @@ droplets_tagged: total: 2 +gpu_droplets: + value: + droplets: + - id: 448543583 + name: ml-ai-ubuntu-gpu-h100x1-80gb-tor1 + memory: 245760 + vcpus: 20 + disk: 720 + disk_info: + - type: local + size: + amount: 720 + unit: gib + - type: scratch + size: + amount: 5120 + unit: gib + locked: false + status: active + kernel: null + created_at: 2024-09-30T15:23:36Z + features: + - droplet_agent + - private_networking + backup_ids: [] + next_backup_window: null + snapshot_ids: [] + image: + id: 166407044 + name: AI/ML Ready H100x1 + distribution: Ubuntu + slug: gpu-h100x1-base + public: true + regions: + - nyc3 + - nyc1 + - sfo1 + - nyc2 + - ams2 + - sgp1 + - lon1 + - ams3 + - fra1 + - tor1 + - sfo2 + - blr1 + - sfo3 + - syd1 + created_at: 2024-09-27T15:35:19Z + min_disk_size: 25 + type: base + size_gigabytes: 18.47 + description: GPU H100 1x Base Image + tags: [] + status: available + volume_ids: [] + size: + slug: gpu-h100x1-80gb + memory: 245760 + vcpus: 20 + disk: 720 + transfer: 15 + price_monthly: 4529.3 + price_hourly: 6.74 + regions: + - tor1 + available: true + description: H100 GPU - 1X + gpu_info: + count: 1 + vram: + amount: 80 + unit: gib + model: nvidia_h100 + disk_info: + - type: local + size: + amount: 720 + unit: gib + - type: scratch + size: + amount: 5120 + unit: gib + size_slug: gpu-h100x1-80gb + networks: + v4: + - ip_address: '10.128.192.124' + netmask: '255.255.0.0' + gateway: nil + type: private + - ip_address: '192.241.165.154' + netmask: '255.255.255.0' + gateway: '192.241.165.1' + type: public + v6: [] + region: + name: Toronto 1 + slug: tor1 + features: + - backups + - ipv6 + - metadata + - install_agent + - storage + - image_transfer + - server_id + - management_networking + available: true + sizes: + - s-1vcpu-1gb + - s-1vcpu-2gb + - s-1vcpu-3gb + - s-2vcpu-2gb + - s-3vcpu-1gb + - s-2vcpu-4gb + - s-4vcpu-8gb + - s-6vcpu-16gb + - s-8vcpu-32gb + - s-12vcpu-48gb + - s-16vcpu-64gb + - s-20vcpu-96gb + - s-24vcpu-128gb + - s-32vcpu-192g + - gpu-h100x1-80gb + - gpu-h100x8-640gb + tags: [] + vpc_uuid: e2fdd15c-6ae6-4c11-8c5d-72dae2ba1ad1 + gpu_info: + count: 1 + vram: + amount: 80 + unit: gib + model: nvidia_h100 + links: {} + meta: + total: 1 + droplet_single: value: droplet: @@ -602,6 +764,11 @@ droplet_single: memory: 1024 vcpus: 1 disk: 25 + disk_info: + - type: "local" + size: + amount: 25 + unit: "gib" locked: false status: active kernel: null @@ -726,6 +893,11 @@ droplet_create_response: memory: 1024 vcpus: 1 disk: 25 + disk_info: + - type: "local" + size: + amount: 25 + unit: "gib" locked: false status: new kernel: null @@ -839,6 +1011,11 @@ droplet_multi_create_response: memory: 1024 vcpus: 1 disk: 25 + disk_info: + - type: "local" + size: + amount: 25 + unit: "gib" locked: false status: new kernel: null @@ -943,6 +1120,11 @@ droplet_multi_create_response: memory: 1024 vcpus: 1 disk: 25 + disk_info: + - type: "local" + size: + amount: 25 + unit: "gib" locked: false status: new kernel: null diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_rules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_rules.yml index 11de54796..2f04e1646 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_rules.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_rules.yml @@ -76,4 +76,4 @@ x-codeSamples: security: - bearer_auth: - - 'firewall:create' + - 'firewall:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_tags.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_tags.yml index 712535d2c..6fec85907 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_tags.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_tags.yml @@ -66,4 +66,4 @@ x-codeSamples: security: - bearer_auth: - - 'firewall:create' + - 'firewall:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_assign_droplets.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_assign_droplets.yml index 14f80c1fe..0f076b6d0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_assign_droplets.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_assign_droplets.yml @@ -69,4 +69,4 @@ x-codeSamples: security: - bearer_auth: - - 'firewall:create' + - 'firewall:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_droplets.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_droplets.yml index 5b8110532..8f48c7f05 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_droplets.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_droplets.yml @@ -69,4 +69,4 @@ x-codeSamples: security: - bearer_auth: - - 'firewall:delete' + - 'firewall:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_rules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_rules.yml index fd56b2a39..057356256 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_rules.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_rules.yml @@ -76,4 +76,4 @@ x-codeSamples: security: - bearer_auth: - - 'firewall:delete' + - 'firewall:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_tags.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_tags.yml index 4282d92f7..5bd1d3e4f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_tags.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_tags.yml @@ -66,4 +66,4 @@ x-codeSamples: security: - bearer_auth: - - 'firewall:delete' + - 'firewall:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_create_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_create_cluster.yml index f5bc62c11..454e249db 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_create_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_create_cluster.yml @@ -10,7 +10,7 @@ description: | The request may contain a maintenance window policy describing a time period when disruptive maintenance tasks may be carried out. Omitting the policy implies that a window will be chosen automatically. See - [here](https://www.digitalocean.com/docs/kubernetes/how-to/upgrade-cluster/) + [here](https://docs.digitalocean.com/products/kubernetes/how-to/upgrade-cluster/) for details. tags: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml index 23faf9bfd..1c0443ac0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml @@ -9,7 +9,7 @@ description: | The resulting JSON object contains token-based authentication for clusters supporting it, and certificate-based authentication otherwise. For a list of supported versions and more information, see "[How to Connect to a DigitalOcean - Kubernetes Cluster with kubectl](https://www.digitalocean.com/docs/kubernetes/how-to/connect-with-kubectl/)". + Kubernetes Cluster](https://docs.digitalocean.com/products/kubernetes/how-to/connect-to-cluster/)". To retrieve credentials for accessing a Kubernetes cluster, send a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/credentials`. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_kubeconfig.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_kubeconfig.yml index e2c6f374a..0314737a8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_kubeconfig.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_kubeconfig.yml @@ -10,7 +10,7 @@ description: | The resulting kubeconfig file uses token-based authentication for clusters supporting it, and certificate-based authentication otherwise. For a list of supported versions and more information, see "[How to Connect to a DigitalOcean - Kubernetes Cluster with kubectl](https://www.digitalocean.com/docs/kubernetes/how-to/connect-with-kubectl/)". + Kubernetes Cluster](https://docs.digitalocean.com/products/kubernetes/how-to/connect-to-cluster/)". To retrieve a kubeconfig file for use with a Kubernetes cluster, send a GET request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig`. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster.yml index 44b4b4ad8..6411eb765 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster.yml @@ -32,15 +32,14 @@ properties: cluster_subnet: type: string format: cidr - readOnly: true - example: 10.244.0.0/16 - description: The range of IP addresses in the overlay network of the + example: 192.168.0.0/20 + description: The range of IP addresses for the overlay network of the Kubernetes cluster in CIDR notation. service_subnet: type: string - readOnly: true - example: 10.245.0.0/16 + format: cidr + example: 192.168.16.0/24 description: The range of assignable IP addresses for services running in the Kubernetes cluster in CIDR notation. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/credentials.yml index 1578ef862..2e2a42706 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/credentials.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/credentials.yml @@ -27,7 +27,7 @@ properties: Newly created Kubernetes clusters do not return credentials using certificate-based authentication. For additional information, - [see here](https://www.digitalocean.com/docs/kubernetes/how-to/connect-to-cluster/#authenticate). + [see here](https://docs.digitalocean.com/products/kubernetes/how-to/connect-to-cluster/#authenticate). client_key_data: type: string @@ -42,7 +42,7 @@ properties: Newly created Kubernetes clusters do not return credentials using certificate-based authentication. For additional information, - [see here](https://www.digitalocean.com/docs/kubernetes/how-to/connect-to-cluster/#authenticate). + [see here](https://docs.digitalocean.com/products/kubernetes/how-to/connect-to-cluster/#authenticate). token: type: string diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/load_balancer_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/load_balancer_base.yml index fd41ac391..73265f81b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/load_balancer_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/load_balancer_base.yml @@ -157,5 +157,17 @@ properties: firewall: $ref: 'lb_firewall.yml' + network: + type: string + example: EXTERNAL + enum: + - EXTERNAL + - INTERNAL + default: EXTERNAL + description: A string indicating whether the load balancer should be external + or internal. Internal load balancers have no public IPs and are only accessible + to resources on the same VPC network. This property cannot be updated after + creating the load balancer. + required: - forwarding_rules diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_create_destination.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_create_destination.yml new file mode 100644 index 000000000..905f0391a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_create_destination.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/sinks/destinations" \ + --data '{"name":"cluster", "type":"opensearch_dbaas", "config": {"endpoint": "example.com", "credentials": {"username": "username", "password": "password"}}}' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_create_sink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_create_sink.yml new file mode 100644 index 000000000..b3d54e91f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_create_sink.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/sinks" \ + --data '{"destination_uuid": "f2fcd5d9-f410-4f3a-8015-130ada94b1fe", "resources": [{"name": "fra_kubernetes_cluster", "urn":"do:kubernetes:8463c9db-150c-4b44-830c-fca7f68d005b"}]}' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_delete_destination.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_delete_destination.yml new file mode 100644 index 000000000..fe70e1733 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_delete_destination.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/sinks/destinations/01f30bfa-319a-4769-ba95-9d43971fb514" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_delete_sink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_delete_sink.yml new file mode 100644 index 000000000..765413813 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_delete_sink.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/sinks/aef7ff4a-f1be-4d9e-b886-650fcb5bdfe3" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_destination.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_destination.yml new file mode 100644 index 000000000..760018bc6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_destination.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/sinks/destinations/01f30bfa-319a-4769-ba95-9d43971fb514" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_sink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_sink.yml new file mode 100644 index 000000000..bf83d49d7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_sink.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/sinks/f945d774-86e8-4dc8-8f60-cfc76dd3d098" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_list_destinations.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_list_destinations.yml new file mode 100644 index 000000000..0fc30e1e5 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_list_destinations.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/sinks/destinations" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_list_sinks.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_list_sinks.yml new file mode 100644 index 000000000..e5a2bb30b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_list_sinks.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/sinks?resource_id=do:kubernetes:f2fcd5d9-f410-4f3a-8015-130ada94b1fe" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_update_destination.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_update_destination.yml new file mode 100644 index 000000000..ffda20fcd --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_update_destination.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X PATCH \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/sinks/destinations/01f30bfa-319a-4769-ba95-9d43971fb514" \ + --data '{"index_name": "logs", "retention_days": 30}' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/destination.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/destination.yml new file mode 100644 index 000000000..e7a5a8c88 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/destination.yml @@ -0,0 +1,22 @@ +type: object +required: + - config +properties: + id: + type: string + description: "A unique identifier for a destination." + example: "01f30bfa-319a-4769-ba95-9d43971fb514" + name: + type: string + description: "destination name" + example: "managed_opensearch_cluster" + type: + enum: + - opensearch_dbaas + - opensearch_ext + description: | + The destination type. `opensearch_dbaas` for a DigitalOcean managed OpenSearch + cluster or `opensearch_ext` for an externally managed one. + example: "opensearch_dbaas" + config: + $ref: 'opensearch_config.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/destination_omit_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/destination_omit_credentials.yml new file mode 100644 index 000000000..26967db56 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/destination_omit_credentials.yml @@ -0,0 +1,20 @@ +type: object +properties: + id: + type: string + description: "A unique identifier for a destination." + example: "01f30bfa-319a-4769-ba95-9d43971fb514" + name: + type: string + description: "destination name" + example: "managed_opensearch_cluster" + type: + enum: + - opensearch_dbaas + - opensearch_ext + description: | + The destination type. `opensearch_dbaas` for a DigitalOcean managed OpenSearch + cluster or `opensearch_ext` for an externally managed one. + example: opensearch_dbaas + config: + $ref: 'opensearch_config_omit_credentials.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/destination_request.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/destination_request.yml new file mode 100644 index 000000000..e4f121778 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/destination_request.yml @@ -0,0 +1,18 @@ +type: object +required: + - config + - type +properties: + name: + type: string + description: "destination name" + example: "managed_opensearch_cluster" + type: + enum: + - opensearch_dbaas + - opensearch_ext + description: | + The destination type. `opensearch_dbaas` for a DigitalOcean managed OpenSearch + cluster or `opensearch_ext` for an externally managed one. + config: + $ref: 'opensearch_config_request.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/opensearch_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/opensearch_config.yml new file mode 100644 index 000000000..0817e0505 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/opensearch_config.yml @@ -0,0 +1,38 @@ +type: object +required: + - endpoint +properties: + id: + type: string + description: "A unique identifier for a configuration." + example: "41078d41-165c-4cff-9f0a-19536e3e3d49" + credentials: + type: object + description: "Credentials for an OpenSearch cluster user. Optional if `cluster_uuid` is passed." + properties: + username: + type: string + example: "username" + password: + type: string + example: "password" + endpoint: + type: string + example: "example.com" + description: "host of the OpenSearch cluster" + cluster_uuid: + type: string + example: "85148069-7e35-4999-80bd-6fa1637ca385" + description: "A unique identifier for a managed OpenSearch cluster." + cluster_name: + type: string + example: "managed_dbaas_cluster" + description: "Name of a managed OpenSearch cluster." + index_name: + type: string + description: "OpenSearch index to send logs to." + example: "logs" + retention_days: + type: integer + description: "Number of days to retain logs in OpenSearch (default: 14)" + example: 14 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/opensearch_config_omit_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/opensearch_config_omit_credentials.yml new file mode 100644 index 000000000..0c99546df --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/opensearch_config_omit_credentials.yml @@ -0,0 +1,28 @@ +type: object +description: "OpenSearch destination configuration with `credentials` omitted." +properties: + id: + type: string + description: "A unique identifier for a configuration." + example: "41078d41-165c-4cff-9f0a-19536e3e3d49" + endpoint: + type: string + example: "example.com" + description: "host of the OpenSearch cluster" + cluster_uuid: + type: string + example: "85148069-7e35-4999-80bd-6fa1637ca385" + description: "A unique identifier for a managed OpenSearch cluster." + cluster_name: + type: string + example: "managed_dbaas_cluster" + description: "Name of a managed OpenSearch cluster." + index_name: + type: string + description: "OpenSearch index to send logs to." + example: "logs" + retention_days: + type: integer + description: "Number of days to retain logs in OpenSearch." + example: 14 + default: 14 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/opensearch_config_request.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/opensearch_config_request.yml new file mode 100644 index 000000000..19f9581e9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/opensearch_config_request.yml @@ -0,0 +1,37 @@ +type: object +required: + - endpoint +properties: + credentials: + type: object + description: "Credentials for an OpenSearch cluster user. Optional if `cluster_uuid` is passed." + properties: + username: + type: string + example: "username" + password: + type: string + example: "password" + endpoint: + type: string + example: "example.com" + description: "host of the OpenSearch cluster" + cluster_uuid: + type: string + example: "85148069-7e35-4999-80bd-6fa1637ca385" + description: "A unique identifier for a managed OpenSearch cluster." + cluster_name: + type: string + example: "managed_dbaas_cluster" + description: "Name of a managed OpenSearch cluster." + index_name: + type: string + description: "OpenSearch index to send logs to." + example: "logs" + retention_days: + type: integer + description: "Number of days to retain logs in an OpenSearch cluster." + example: 14 + default: 14 + + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/sink_resource.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/sink_resource.yml new file mode 100644 index 000000000..91bd80c6c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/sink_resource.yml @@ -0,0 +1,14 @@ +type: object +required: + - urn +properties: + urn: + type: string + pattern: ^do:kubernetes:.* + example: do:kubernetes:f453aa14-646e-4cf8-8c62-75a19fb24ec2 + description: The uniform resource name (URN) for the resource in the format + do:resource_type:resource_id. + name: + type: string + description: "resource name" + example: "managed_kubernetes_cluster" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/sinks_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/sinks_response.yml new file mode 100644 index 000000000..81aa4be7a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/sinks_response.yml @@ -0,0 +1,11 @@ +type: object +required: + - urn +properties: + destination: + $ref: '../models/destination.yml' + resources: + type: array + description: "List of resources identified by their URNs." + items: + $ref: '../models/sink_resource.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml index 367259a2a..08f871b92 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml @@ -44,7 +44,7 @@ requestBody: `v1/insights/lbaas/avg_cpu_utilization_percent`|alert on the percent of CPU utilization|load balancer ID `v1/insights/lbaas/connection_utilization_percent`|alert on the percent of connection utilization|load balancer ID `v1/insights/lbaas/droplet_health`|alert on Droplet health status changes|load balancer ID - `v1/insights/lbaas/tls_connections_per_second_utilization_percent`|alert on the percent of TLS connections per second utilization|load balancer ID + `v1/insights/lbaas/tls_connections_per_second_utilization_percent`|alert on the percent of TLS connections per second utilization (requires at least one HTTPS forwarding rule)|load balancer ID `v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx`|alert on the percent increase of 5xx level http errors over 5m|load balancer ID `v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx`|alert on the percent increase of 4xx level http errors over 5m|load balancer ID `v1/insights/lbaas/increase_in_http_error_rate_count_5xx`|alert on the count of 5xx level http errors over 5m|load balancer ID diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_destination.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_destination.yml new file mode 100644 index 000000000..bc89890e2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_destination.yml @@ -0,0 +1,64 @@ +operationId: monitoring_create_destination + +summary: Create Logging Destination + +description: To create a new destination, send a POST request to `/v2/monitoring/sinks/destinations`. + +tags: + - Monitoring + +requestBody: + required: true + content: + application/json: + schema: + $ref: 'models/destination_request.yml' + + examples: + Managed OpenSearch Cluster: + value: + name: managed_opensearch_cluster + type: opensearch_dbaas + config: + endpoint: db-opensearch-nyc3-123456-do-user-123456-0.g.db.ondigitalocean.com + cluster_uuid: 85148069-7e35-4999-80bd-6fa1637ca385 + cluster_name: managed_dbaas_cluster + index_name: logs + retention_days: 14 + External OpenSearch Cluster: + value: + name: external_opensearch + type: opensearch_ext + config: + endpoint: example.com + credentials: + username: username + password: password + index_name: logs + retention_days: 14 + +responses: + '200': + $ref: 'responses/destination.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_create_destination.yml' + +security: + - bearer_auth: + - 'monitoring:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_sink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_sink.yml new file mode 100644 index 000000000..6acdeedee --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_sink.yml @@ -0,0 +1,52 @@ +operationId: monitoring_create_sink + +summary: Create Sink + +description: | + To create a new sink, send a POST request to `/v2/monitoring/sinks`. Forwards logs from the + resources identified in `resources` to the specified pre-existing destination. + +tags: + - Monitoring + +responses: + '202': + $ref: '../../shared/responses/accepted.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +requestBody: + required: true + content: + application/json: + schema: + properties: + destination_uuid: + type: string + example: "9df2b7e9-3fb2-4577-b60a-e9c0d53f9a99" + description: "A unique identifier for an already-existing destination." + resources: + type: array + description: "List of resources identified by their URNs." + items: + $ref: 'models/sink_resource.yml' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_create_sink.yml' + +security: + - bearer_auth: + - 'monitoring:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_delete_destination.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_delete_destination.yml new file mode 100644 index 000000000..96c7ace6e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_delete_destination.yml @@ -0,0 +1,37 @@ +operationId: monitoring_delete_destination + +summary: Delete Logging Destination + +description: To delete a destination and all associated sinks, send a DELETE request to `/v2/monitoring/sinks/destinations/${destination_uuid}`. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/destination_uuid' + +responses: + '204': + $ref: '../../shared/responses/no_content.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_delete_destination.yml' + +security: + - bearer_auth: + - 'monitoring:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_delete_sink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_delete_sink.yml new file mode 100644 index 000000000..82348581c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_delete_sink.yml @@ -0,0 +1,37 @@ +operationId: monitoring_delete_sink + +summary: Delete Sink + +description: To delete a sink, send a DELETE request to `/v2/monitoring/sinks/${sink_uuid}`. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/sink_uuid' + +responses: + '204': + $ref: '../../shared/responses/no_content.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_delete_sink.yml' + +security: + - bearer_auth: + - 'monitoring:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_destination.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_destination.yml new file mode 100644 index 000000000..13504f5d7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_destination.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_destination + +summary: Get Logging Destination + +description: To get the details of a destination, send a GET request to `/v2/monitoring/sinks/destinations/${destination_uuid}`. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/destination_uuid' + +responses: + '200': + $ref: 'responses/destination.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_destination.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_sink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_sink.yml new file mode 100644 index 000000000..127b76517 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_sink.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_sink + +summary: Get Sink + +description: To get the details of a sink (resources and destination), send a GET request to `/v2/monitoring/sinks/${sink_uuid}`. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/sink_uuid' + +responses: + '200': + $ref: 'responses/sinks.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_sink.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_list_destinations.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_list_destinations.yml new file mode 100644 index 000000000..1ad91fa88 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_list_destinations.yml @@ -0,0 +1,34 @@ +operationId: monitoring_list_destinations + +summary: List Logging Destinations + +description: To list all logging destinations, send a GET request to `/v2/monitoring/sinks/destinations`. + +tags: + - Monitoring + +responses: + '200': + $ref: 'responses/monitoring_list_destinations.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_list_destinations.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_list_sinks.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_list_sinks.yml new file mode 100644 index 000000000..de317187f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_list_sinks.yml @@ -0,0 +1,37 @@ +operationId: monitoring_list_sinks + +summary: Lists all sinks + +description: To list all sinks, send a GET request to `/v2/monitoring/sinks`. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/resource_id' + +responses: + '200': + $ref: 'responses/list_sinks.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_list_sinks.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml index 0bf239d38..6d1b99516 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml @@ -49,7 +49,7 @@ requestBody: `v1/insights/lbaas/avg_cpu_utilization_percent`|alert on the percent of CPU utilization|load balancer ID `v1/insights/lbaas/connection_utilization_percent`|alert on the percent of connection utilization|load balancer ID `v1/insights/lbaas/droplet_health`|alert on Droplet health status changes|load balancer ID - `v1/insights/lbaas/tls_connections_per_second_utilization_percent`|alert on the percent of TLS connections per second utilization|load balancer ID + `v1/insights/lbaas/tls_connections_per_second_utilization_percent`|alert on the percent of TLS connections per second utilization (requires at least one HTTPS forwarding rule)|load balancer ID `v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx`|alert on the percent increase of 5xx level http errors over 5m|load balancer ID `v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx`|alert on the percent increase of 4xx level http errors over 5m|load balancer ID `v1/insights/lbaas/increase_in_http_error_rate_count_5xx`|alert on the count of 5xx level http errors over 5m|load balancer ID diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_destination.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_destination.yml new file mode 100644 index 000000000..3cbddb069 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_destination.yml @@ -0,0 +1,44 @@ +operationId: monitoring_update_destination + +summary: Update Logging Destination + +description: To update the details of a destination, send a PATCH request to `/v2/monitoring/sinks/destinations/${destination_uuid}`. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/destination_uuid' + +responses: + '204': + $ref: '../../shared/responses/no_content.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +requestBody: + required: true + content: + application/json: + schema: + $ref: 'models/destination_request.yml' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_update_destination.yml' + +security: + - bearer_auth: + - 'monitoring:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml index 4cba95de1..f39555717 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml @@ -25,6 +25,14 @@ load_balancer_id: type: string example: 4de7ac8b-495b-4884-9a69-1050c6793cd6 +resource_id: + in: query + name: resource_id + description: A unique URN for a resource. + schema: + $ref: '../../shared/attributes/urn.yml' + example: do:kubernetes:5ba4518b-b9e2-4978-aa92-2d4c727e8824 + app_component: in: query name: app_component @@ -82,3 +90,21 @@ alert_uuid: schema: type: string example: 4de7ac8b-495b-4884-9a69-1050c6793cd6 + +destination_uuid: + in: path + name: destination_uuid + description: A unique identifier for a destination. + required: true + schema: + type: string + example: 1a64809f-1708-48ee-a742-dec8d481b8d1 + +sink_uuid: + in: path + name: sink_uuid + description: A unique identifier for a sink. + required: true + schema: + type: string + example: 78b172b6-52c3-4a4b-96d5-78d3f1a0b18c diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/destination.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/destination.yml new file mode 100644 index 000000000..25475607e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/destination.yml @@ -0,0 +1,16 @@ +description: The response is a JSON object with a `destination` key. + +headers: + ratelimit-limit: + $ref: '../../../shared/headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../../../shared/headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../../../shared/headers.yml#/ratelimit-reset' + +content: + application/json: + schema: + properties: + destination: + $ref: '../models/destination_omit_credentials.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/list_sinks.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/list_sinks.yml new file mode 100644 index 000000000..7e8500926 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/list_sinks.yml @@ -0,0 +1,19 @@ +description: The response is a JSON object with a `sinks` key. + +headers: + ratelimit-limit: + $ref: '../../../shared/headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../../../shared/headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../../../shared/headers.yml#/ratelimit-reset' + +content: + application/json: + schema: + properties: + sinks: + type: array + description: "List of sinks identified by their URNs." + items: + $ref: '../models/sinks_response.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/monitoring_list_destinations.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/monitoring_list_destinations.yml new file mode 100644 index 000000000..bd8cebf04 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/monitoring_list_destinations.yml @@ -0,0 +1,18 @@ +description: The response is a JSON object with a `destinations` key. + +headers: + ratelimit-limit: + $ref: '../../../shared/headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../../../shared/headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../../../shared/headers.yml#/ratelimit-reset' + +content: + application/json: + schema: + properties: + destinations: + type: array + items: + $ref: '../models/destination_omit_credentials.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/sinks.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/sinks.yml new file mode 100644 index 000000000..bca0859e8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/sinks.yml @@ -0,0 +1,16 @@ +description: The response is a JSON object with a `sink` key. + +headers: + ratelimit-limit: + $ref: '../../../shared/headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../../../shared/headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../../../shared/headers.yml#/ratelimit-reset' + +content: + application/json: + schema: + properties: + sink: + $ref: '../models/sinks_response.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_run_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_run_garbageCollection.yml index 57c8c0a64..2303af381 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_run_garbageCollection.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_run_garbageCollection.yml @@ -7,7 +7,7 @@ description: | manifest data) after deleting one or more manifests from a repository. If there are no unreferenced blobs resulting from the deletion of one or more manifests, garbage collection is effectively a noop. - [See here for more information](https://www.digitalocean.com/docs/container-registry/how-to/clean-up-container-registry/) + [See here for more information](https://docs.digitalocean.com/products/container-registry/how-to/clean-up-container-registry/) about how and why you should clean up your container registry periodically. To request a garbage collection run on your registry, send a POST request to diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/models/disk_info.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/models/disk_info.yml new file mode 100644 index 000000000..1b9ba6245 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/models/disk_info.yml @@ -0,0 +1,22 @@ +type: object + +properties: + type: + type: string + enum: + - local + - scratch + description: The type of disk. All Droplets contain a `local` disk. Additionally, + GPU Droplets can also have a `scratch` disk for non-persistent data. + example: local + size: + type: object + properties: + amount: + type: integer + description: The amount of space allocated to the disk. + example: 25 + unit: + type: string + description: The unit of measure for the disk size. + example: gib diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/models/gpu_info.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/models/gpu_info.yml new file mode 100644 index 000000000..ffcd4c6ee --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/models/gpu_info.yml @@ -0,0 +1,25 @@ +type: object +description: >- + An object containing information about the GPU capabilities of Droplets + created with this size. + +properties: + count: + type: integer + description: The number of GPUs allocated to the Droplet. + example: 1 + model: + type: string + description: The model of the GPU. + example: nvidia_h100 + vram: + type: object + properties: + amount: + type: integer + description: The amount of VRAM allocated to the GPU. + example: 25 + unit: + type: string + description: The unit of measure for the VRAM. + example: gib diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/models/size.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/models/size.yml index 7193ba7a0..1f62f31e9 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/models/size.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/models/size.yml @@ -18,7 +18,7 @@ properties: vcpus: type: integer example: 1 - description: The integer of number CPUs allocated to Droplets of this size. + description: The number of CPUs allocated to Droplets of this size. disk: type: integer @@ -85,6 +85,16 @@ properties: example: Basic, General Purpose, CPU-Optimized, Memory-Optimized, or Storage-Optimized. + disk_info: + type: array + description: An array of objects containing information about the disks + available to Droplets created with this size. + items: + $ref: './disk_info.yml' + + gpu_info: + $ref: './gpu_info.yml' + required: - available - disk diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/responses/all_sizes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/responses/all_sizes.yml index 4ef6715fc..17d51f2cc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/responses/all_sizes.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/responses/all_sizes.yml @@ -51,6 +51,11 @@ content: - tor1 available: true description: Basic + disk_info: + - type: "local" + size: + amount: 25 + unit: "gib" links: pages: last: "https://api.digitalocean.com/v2/sizes?page=64&per_page=1" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml index f3733d880..67dabd1a1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml @@ -20,7 +20,7 @@ description: | volumes may be attached to a Droplet at a time. Pre-formatted volumes will be automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018 when attached. On older Droplets, - [additional configuration](https://www.digitalocean.com/community/tutorials/how-to-partition-and-format-digitalocean-block-storage-volumes-in-linux#mounting-the-filesystems) + [additional configuration](https://docs.digitalocean.com/products/volumes/how-to/mount/) is required. ## Remove a Block Storage Volume from a Droplet diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml index 084c5b255..316ab95bf 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml @@ -19,7 +19,7 @@ description: | volumes may be attached to a Droplet at a time. Pre-formatted volumes will be automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018 when attached. On older Droplets, - [additional configuration](https://www.digitalocean.com/community/tutorials/how-to-partition-and-format-digitalocean-block-storage-volumes-in-linux#mounting-the-filesystems) + [additional configuration](https://docs.digitalocean.com/products/volumes/how-to/mount/) is required. ## Remove a Block Storage Volume from a Droplet diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/examples/curl/vpc_peerings_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/examples/curl/vpc_peerings_create.yml new file mode 100644 index 000000000..86217fabc --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/examples/curl/vpc_peerings_create.yml @@ -0,0 +1,8 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"name": "my-first-vpc-peering", "vpc_ids": [ "997615ce-132d-4bae-9270-9ee21b395e5d", "e51aed59-3bb1-4a6a-8de0-9d1329e9c997"]}' \ + "https://api.digitalocean.com/v2/vpc_peerings" + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/examples/curl/vpc_peerings_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/examples/curl/vpc_peerings_delete.yml new file mode 100644 index 000000000..b7e56238e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/examples/curl/vpc_peerings_delete.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/vpc_peerings/6b5c619c-359c-44ca-87e2-47e98170c01d" + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/examples/curl/vpc_peerings_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/examples/curl/vpc_peerings_get.yml new file mode 100644 index 000000000..af316b8ed --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/examples/curl/vpc_peerings_get.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/vpc_peerings/5a4981aa-9653-4bd1-bef5-d6bff52042e4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/examples/curl/vpc_peerings_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/examples/curl/vpc_peerings_list.yml new file mode 100644 index 000000000..ff5564e33 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/examples/curl/vpc_peerings_list.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/vpc_peerings?region=sfo3&page=1&per_page=20" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/examples/curl/vpc_peerings_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/examples/curl/vpc_peerings_update.yml new file mode 100644 index 000000000..30c0daf9d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/examples/curl/vpc_peerings_update.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X PATCH \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"name":"renamed-vpc-peering"}' \ + "https://api.digitalocean.com/v2/vpc_peerings/5a4981aa-9653-4bd1-bef5-d6bff52042e4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/models/vpc_peering.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/models/vpc_peering.yml new file mode 100644 index 000000000..2351b3af7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/models/vpc_peering.yml @@ -0,0 +1,58 @@ +vpc_peering: + type: object + allOf: + - $ref: '#/vpc_peering_base' + - $ref: '#/vpc_peering_create' + - $ref: '#/vpc_peering_updatable' + +vpc_peering_base: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + example: 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + description: A unique ID that can be used to identify and reference the VPC peering. + + created_at: + type: string + format: date-time + readOnly: true + example: "2020-03-13T19:20:47.442049222Z" + description: A time value given in ISO8601 combined date and time format. + + status: + type: string + enum: + - PROVISIONING + - ACTIVE + - DELETING + readOnly: true + example: "ACTIVE" + description: The current status of the VPC peering. + +vpc_peering_create: + type: object + properties: + vpc_ids: + type: array + items: + type: string + format: uuid + minItems: 2 + maxItems: 2 + example: + - c140286f-e6ce-4131-8b7b-df4590ce8d6a + - 994a2735-dc84-11e8-80bc-3cfdfea9fba1 + description: An array of the two peered VPCs IDs. + +vpc_peering_updatable: + type: object + properties: + name: + type: string + pattern: '^[a-zA-Z0-9\-]+$' + example: nyc1-blr1-peering + description: The name of the VPC peering. Must be unique within the team + and may only contain alphanumeric characters and dashes. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/parameters.yml new file mode 100644 index 000000000..72b4f8737 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/parameters.yml @@ -0,0 +1,9 @@ +vpc_peering_id: + in: path + name: vpc_peering_id + description: A unique identifier for a VPC peering. + required: true + schema: + type: string + format: uuid + example: 5a4981aa-9653-4bd1-bef5-d6bff52042e4 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/responses/active_vpc_peering.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/responses/active_vpc_peering.yml new file mode 100644 index 000000000..59bb40ce7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/responses/active_vpc_peering.yml @@ -0,0 +1,29 @@ +description: The response will be a JSON object with a key called `vpc_peering`. + The value of this will be an object that contains the standard attributes + associated with a VPC peering. + +headers: + ratelimit-limit: + $ref: '../../../shared/headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../../../shared/headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../../../shared/headers.yml#/ratelimit-reset' + +content: + application/json: + schema: + type: object + properties: + vpc_peering: + $ref: '../models/vpc_peering.yml#/vpc_peering' + + example: + vpc_peering: + id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + name: example-vpc-peering + vpc_ids: + - 997615ce-132d-4bae-9270-9ee21b395e5d + - e51aed59-3bb1-4a6a-8de0-9d1329e9c997 + created_at: '2024-01-09T20:44:32Z' + status: ACTIVE \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/responses/all_vpc_peerings.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/responses/all_vpc_peerings.yml new file mode 100644 index 000000000..0abac4ced --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/responses/all_vpc_peerings.yml @@ -0,0 +1,48 @@ +description: >- + The response will be a JSON object with a key called `vpc_peerings`. This + will be set to an array of objects, each of which will contain the standard + attributes associated with a VPC peering. + +headers: + ratelimit-limit: + $ref: '../../../shared/headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../../../shared/headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../../../shared/headers.yml#/ratelimit-reset' + +content: + application/json: + schema: + allOf: + - type: object + properties: + vpc_peerings: + type: array + items: + $ref: '../models/vpc_peering.yml#/vpc_peering' + - $ref: '../../../shared/pages.yml#/pagination' + - $ref: '../../../shared/meta.yml' + + example: + vpc_peerings: + - id: 6b5c619c-359c-44ca-87e2-47e98170c01d + name: example-vpc-peering + vpc_ids: + - 997615ce-132d-4bae-9270-9ee21b395e5d + - e51aed59-3bb1-4a6a-8de0-9d1329e9c997 + created_at: '2024-01-09T20:44:32Z' + status: ACTIVE + - id: c212b274-911c-44cc-a117-23b7da4a2922 + name: another-vpc-peering + vpc_ids: + - 5a100736-b085-4f69-81fd-feee325784bb + - c140286f-e6ce-4131-8b7b-df4590ce8d6a + created_at: '2024-01-10T13:29:58Z' + status: ACTIVE + links: {} + meta: + total: 2 + + + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/responses/deleting_vpc_peering.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/responses/deleting_vpc_peering.yml new file mode 100644 index 000000000..816d6c7b2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/responses/deleting_vpc_peering.yml @@ -0,0 +1,29 @@ +description: The response will be a JSON object with a key called `vpc_peering`. + The value of this will be an object that contains the standard attributes + associated with a VPC peering. + +headers: + ratelimit-limit: + $ref: '../../../shared/headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../../../shared/headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../../../shared/headers.yml#/ratelimit-reset' + +content: + application/json: + schema: + type: object + properties: + vpc_peering: + $ref: '../models/vpc_peering.yml#/vpc_peering' + + example: + vpc_peering: + id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + name: example-vpc-peering + vpc_ids: + - 997615ce-132d-4bae-9270-9ee21b395e5d + - e51aed59-3bb1-4a6a-8de0-9d1329e9c997 + created_at: '2024-01-09T20:44:32Z' + status: DELETING \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/responses/provisioning_vpc_peering.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/responses/provisioning_vpc_peering.yml new file mode 100644 index 000000000..1668eae58 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/responses/provisioning_vpc_peering.yml @@ -0,0 +1,29 @@ +description: The response will be a JSON object with a key called `vpc_peering`. + The value of this will be an object that contains the standard attributes + associated with a VPC peering. + +headers: + ratelimit-limit: + $ref: '../../../shared/headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../../../shared/headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../../../shared/headers.yml#/ratelimit-reset' + +content: + application/json: + schema: + type: object + properties: + vpc_peering: + $ref: '../models/vpc_peering.yml#/vpc_peering' + + example: + vpc_peering: + id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + name: example-vpc-peering + vpc_ids: + - 997615ce-132d-4bae-9270-9ee21b395e5d + - e51aed59-3bb1-4a6a-8de0-9d1329e9c997 + created_at: '2024-01-09T20:44:32Z' + status: PROVISIONING \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/vpc_peerings_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/vpc_peerings_create.yml new file mode 100644 index 000000000..bf33b902c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/vpc_peerings_create.yml @@ -0,0 +1,51 @@ +operationId: vpcPeerings_create + +summary: Create a New VPC Peering + +description: | + To create a new VPC Peering, send a POST request to `/v2/vpc_peerings` + specifying a name and a list of two VPC IDs to peer. The response code, 202 + Accepted, does not indicate the success or failure of the operation, just + that the request has been accepted for processing. + +tags: + - VPC Peerings + +requestBody: + required: true + + content: + application/json: + schema: + type: object + allOf: + - $ref: 'models/vpc_peering.yml#/vpc_peering_updatable' + - $ref: 'models/vpc_peering.yml#/vpc_peering_create' + + required: + - name + - vpc_ids + + +responses: + '202': + $ref: 'responses/provisioning_vpc_peering.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/vpc_peerings_create.yml' + +security: + - bearer_auth: + - 'vpc_peering:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/vpc_peerings_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/vpc_peerings_delete.yml new file mode 100644 index 000000000..485ec25ba --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/vpc_peerings_delete.yml @@ -0,0 +1,38 @@ +operationId: vpcPeerings_delete + +summary: Delete a VPC peering + +description: | + To delete a VPC peering, send a DELETE request to `/v2/vpc_peerings/$VPC_PEERING_ID`. + +tags: + - VPC Peerings + +parameters: + - $ref: 'parameters.yml#/vpc_peering_id' + +responses: + '202': + $ref: 'responses/deleting_vpc_peering.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/vpc_peerings_delete.yml' + +security: + - bearer_auth: + - 'vpc_peering:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/vpc_peerings_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/vpc_peerings_get.yml new file mode 100644 index 000000000..8a3cd72db --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/vpc_peerings_get.yml @@ -0,0 +1,38 @@ +operationId: vpcPeerings_get + +summary: Retrieve an Existing VPC Peering + +description: | + To show information about an existing VPC Peering, send a GET request to `/v2/vpc_peerings/$VPC_PEERING_ID`. + +tags: + - VPC Peerings + +parameters: + - $ref: 'parameters.yml#/vpc_peering_id' + +responses: + '200': + $ref: 'responses/active_vpc_peering.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/vpc_peerings_get.yml' + +security: + - bearer_auth: + - 'vpc_peering:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/vpc_peerings_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/vpc_peerings_list.yml new file mode 100644 index 000000000..83e2f95c2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/vpc_peerings_list.yml @@ -0,0 +1,42 @@ +operationId: vpcPeerings_list + +summary: List All VPC Peerings + +description: To list all of the VPC peerings on your account, send a GET request + to `/v2/vpc_peerings`. + +tags: + - VPC Peerings + +parameters: + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + - $ref: '../../shared/parameters.yml#/region' + + +responses: + '200': + $ref: 'responses/all_vpc_peerings.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/vpc_peerings_list.yml' + + +security: + - bearer_auth: + - 'vpc_peering:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/vpc_peerings_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/vpc_peerings_update.yml new file mode 100644 index 000000000..5fc5ce040 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_peerings/vpc_peerings_update.yml @@ -0,0 +1,51 @@ +operationId: vpcPeerings_patch + +summary: Update a VPC peering + +description: | + To update the name of a VPC peering, send a PATCH request to `/v2/vpc_peerings/$VPC_PEERING_ID` with the new `name` in the request body. + +tags: + - VPC Peerings + +parameters: + - $ref: 'parameters.yml#/vpc_peering_id' + +requestBody: + required: true + + content: + application/json: + schema: + type: object + allOf: + - $ref: 'models/vpc_peering.yml#/vpc_peering_updatable' + + required: + - name + +responses: + '200': + $ref: 'responses/active_vpc_peering.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/vpc_peerings_update.yml' + +security: + - bearer_auth: + - 'vpc_peering:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/examples/curl/vpcs_create_peerings.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/examples/curl/vpcs_create_peerings.yml new file mode 100644 index 000000000..ccedb7e9e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/examples/curl/vpcs_create_peerings.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"name":"example-vpc-peering", "vpc_id": "e51aed59-3bb1-4a6a-8de0-9d1329e9c997"}' \ + "https://api.digitalocean.com/v2/vpcs/5a4981aa-9653-4bd1-bef5-d6bff52042e4/peerings" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/examples/curl/vpcs_list_peerings.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/examples/curl/vpcs_list_peerings.yml new file mode 100644 index 000000000..1fa768cd0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/examples/curl/vpcs_list_peerings.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/vpcs/5a4981aa-9653-4bd1-bef5-d6bff52042e4/peerings" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/examples/curl/vpcs_update_peerings.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/examples/curl/vpcs_update_peerings.yml new file mode 100644 index 000000000..fb1d03bb7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/examples/curl/vpcs_update_peerings.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X PATCH \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"name": "renamed-my-first-vpc-peering"}' \ + "https://api.digitalocean.com/v2/vpcs/997615ce-132d-4bae-9270-9ee21b395e5d/peerings/6b5c619c-359c-44ca-87e2-47e98170c01d" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/parameters.yml index 075c32789..b0b51c79f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/parameters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/parameters.yml @@ -17,3 +17,13 @@ vpc_resource_type: schema: type: string example: droplet + +vpc_peering_id: + in: path + name: vpc_peering_id + description: A unique identifier for a VPC peering. + required: true + schema: + type: string + format: uuid + example: 5a4981aa-9653-4bd1-bef5-d6bff52042e4 \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/responses/vpc_peering.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/responses/vpc_peering.yml new file mode 100644 index 000000000..63e6a72d5 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/responses/vpc_peering.yml @@ -0,0 +1,29 @@ +description: >- + The response will be a JSON object with a key called `peering`, containing + the standard attributes associated with a VPC peering. + +headers: + ratelimit-limit: + $ref: '../../../shared/headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../../../shared/headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../../../shared/headers.yml#/ratelimit-reset' + +content: + application/json: + schema: + type: object + properties: + peering: + $ref: '../../vpc_peerings/models/vpc_peering.yml#/vpc_peering' + + example: + peering: + id: 6b5c619c-359c-44ca-87e2-47e98170c01d + name: example-vpc-peering + vpc_ids: + - 997615ce-132d-4bae-9270-9ee21b395e5d + - e51aed59-3bb1-4a6a-8de0-9d1329e9c997 + created_at: '2024-01-09T20:44:32Z' + status: PROVISIONING diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/responses/vpc_peerings.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/responses/vpc_peerings.yml new file mode 100644 index 000000000..1744a616c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/responses/vpc_peerings.yml @@ -0,0 +1,45 @@ +description: >- + The response will be a JSON object with a key called `peerings`. This + will be set to an array of objects, each of which will contain the standard + attributes associated with a VPC peering. + +headers: + ratelimit-limit: + $ref: '../../../shared/headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../../../shared/headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../../../shared/headers.yml#/ratelimit-reset' + +content: + application/json: + schema: + allOf: + - type: object + properties: + peerings: + type: array + items: + $ref: '../../vpc_peerings/models/vpc_peering.yml#/vpc_peering' + - $ref: '../../../shared/pages.yml#/pagination' + - $ref: '../../../shared/meta.yml' + + example: + peerings: + - id: 6b5c619c-359c-44ca-87e2-47e98170c01d + name: example-vpc-peering + vpc_ids: + - 997615ce-132d-4bae-9270-9ee21b395e5d + - e51aed59-3bb1-4a6a-8de0-9d1329e9c997 + created_at: '2024-01-09T20:44:32Z' + status: ACTIVE + - id: c212b274-911c-44cc-a117-23b7da4a2922 + name: another-vpc-peering + vpc_ids: + - 5a100736-b085-4f69-81fd-feee325784bb + - c140286f-e6ce-4131-8b7b-df4590ce8d6a + created_at: '2024-01-10T13:29:58Z' + status: ACTIVE + links: {} + meta: + total: 2 \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_create_peerings.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_create_peerings.yml new file mode 100644 index 000000000..134482998 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_create_peerings.yml @@ -0,0 +1,63 @@ +operationId: vpcs_create_peerings + +summary: Create a Peering with a VPC + +description: | + To create a new VPC peering for a given VPC, send a POST request to + `/v2/vpcs/$VPC_ID/peerings`. + +tags: + - VPCs + +parameters: + - $ref: 'parameters.yml#/vpc_id' + +requestBody: + required: true + + content: + application/json: + schema: + type: object + properties: + name: + type: string + pattern: '^[a-zA-Z0-9\-\.]+$' + example: nyc1-blr1-peering + description: The name of the VPC peering. Must be unique and may only contain + alphanumeric characters, dashes, and periods. + vpc_id: + type: string + format: uuid + example: c140286f-e6ce-4131-8b7b-df4590ce8d6a + description: The ID of the VPC to peer with. + + required: + - name + - vpc_id + +responses: + '202': + $ref: 'responses/vpc_peering.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/vpcs_create_peerings.yml' + +security: + - bearer_auth: + - 'vpc_peering:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list_peerings.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list_peerings.yml new file mode 100644 index 000000000..815814e39 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list_peerings.yml @@ -0,0 +1,41 @@ +operationId: vpcs_list_peerings + +summary: List the Peerings of a VPC + +description: | + To list all of a VPC's peerings, send a GET request to + `/v2/vpcs/$VPC_ID/peerings`. + +tags: + - VPCs + +parameters: + - $ref: 'parameters.yml#/vpc_id' + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + +responses: + '200': + $ref: 'responses/vpc_peerings.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/vpcs_list_peerings.yml' + +security: + - bearer_auth: + - 'vpc_peering:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_update_peerings.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_update_peerings.yml new file mode 100644 index 000000000..8a792d568 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_update_peerings.yml @@ -0,0 +1,54 @@ +operationId: vpcs_patch_peerings + +summary: Update a VPC Peering + +description: | + To update the name of a VPC peering in a particular VPC, send a PATCH request + to `/v2/vpcs/$VPC_ID/peerings/$VPC_PEERING_ID` with the new `name` in the + request body. + +tags: + - VPCs + +parameters: + - $ref: 'parameters.yml#/vpc_id' + - $ref: 'parameters.yml#/vpc_peering_id' + +requestBody: + required: true + + content: + application/json: + schema: + type: object + allOf: + - $ref: '../vpc_peerings/models/vpc_peering.yml#/vpc_peering_updatable' + + required: + - name + +responses: + '200': + $ref: 'responses/vpc_peering.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/vpcs_update_peerings.yml' + +security: + - bearer_auth: + - 'vpc_peering:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/region_slug.yml b/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/region_slug.yml index 54e5d143c..721a7d973 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/region_slug.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/region_slug.yml @@ -17,4 +17,5 @@ enum: - sfo3 - sgp1 - tor1 + - syd1 example: nyc3 diff --git a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts index e0a3b0a55..6a18d8275 100644 --- a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts @@ -453,7 +453,7 @@ export type paths = { * List accepted assignments for an assignment * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ - readonly get: operations["classroom/list-accepted-assigments-for-an-assignment"]; + readonly get: operations["classroom/list-accepted-assignments-for-an-assignment"]; readonly put?: never; readonly post?: never; readonly delete?: never; @@ -612,13 +612,16 @@ export type paths = { /** * List all Copilot seat assignments for an enterprise * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + * Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. * * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. * * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + * telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + * see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. * @@ -633,6 +636,35 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/enterprises/{enterprise}/copilot/metrics": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get Copilot metrics for an enterprise + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + readonly get: operations["copilot/copilot-metrics-for-enterprise"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/enterprises/{enterprise}/copilot/usage": { readonly parameters: { readonly query?: never; @@ -643,7 +675,7 @@ export type paths = { /** * Get a summary of Copilot usage for enterprise members * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -653,6 +685,8 @@ export type paths = { * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * + * The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + * * Only owners and billing managers can view Copilot usage metrics for the enterprise. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -718,6 +752,38 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get Copilot metrics for an enterprise team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + readonly get: operations["copilot/copilot-metrics-for-enterprise-team"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { readonly parameters: { readonly query?: never; @@ -728,7 +794,7 @@ export type paths = { /** * Get a summary of Copilot usage for an enterprise team * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -1609,10 +1675,10 @@ export type paths = { /** * Update an organization * @description > [!WARNING] - * > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * > **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * > [!WARNING] - * > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * * Updates the organization's profile and member privileges. * @@ -1842,6 +1908,180 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/actions/runner-groups": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List self-hosted runner groups for an organization + * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["actions/list-self-hosted-runner-groups-for-org"]; + readonly put?: never; + /** + * Create a self-hosted runner group for an organization + * @description Creates a new self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly post: operations["actions/create-self-hosted-runner-group-for-org"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a self-hosted runner group for an organization + * @description Gets a specific self-hosted runner group for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["actions/get-self-hosted-runner-group-for-org"]; + readonly put?: never; + readonly post?: never; + /** + * Delete a self-hosted runner group from an organization + * @description Deletes a self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + readonly options?: never; + readonly head?: never; + /** + * Update a self-hosted runner group for an organization + * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly patch: operations["actions/update-self-hosted-runner-group-for-org"]; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List repository access to a self-hosted runner group in an organization + * @description Lists the repositories with access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; + /** + * Set repository access for a self-hosted runner group in an organization + * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + /** + * Add repository access to a self-hosted runner group in an organization + * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + readonly post?: never; + /** + * Remove repository access to a self-hosted runner group in an organization + * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List self-hosted runners in a group for an organization + * @description Lists self-hosted runners that are in a specific organization group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["actions/list-self-hosted-runners-in-group-for-org"]; + /** + * Set self-hosted runners in a group for an organization + * @description Replaces the list of self-hosted runners that are part of an organization runner group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + /** + * Add a self-hosted runner to a group for an organization + * @description Adds a self-hosted runner to a runner group configured in an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + readonly post?: never; + /** + * Remove a self-hosted runner from a group for an organization + * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/actions/runners": { readonly parameters: { readonly query?: never; @@ -2912,11 +3152,11 @@ export type paths = { /** * Get Copilot seat information and settings for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Gets information about an organization's Copilot subscription, including seat breakdown * and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." * * Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. * @@ -2941,11 +3181,14 @@ export type paths = { /** * List all Copilot seat assignments for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + * Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. * Only organization owners can view assigned seats. * + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ readonly get: operations["copilot/list-copilot-seats"]; @@ -2969,16 +3212,16 @@ export type paths = { /** * Add teams to the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * * Only organization owners can add Copilot seats for their organization members. * * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * * The response will contain the total number of new seats that were created and existing seats that were refreshed. * @@ -2988,17 +3231,19 @@ export type paths = { /** * Remove teams from the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Cancels the Copilot seat assignment for all members of each team specified. - * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Sets seats for all members of each team specified to "pending cancellation". + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * + * The response will contain the total number of seats set to "pending cancellation". + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ readonly delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; @@ -3019,16 +3264,16 @@ export type paths = { /** * Add users to the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * * Only organization owners can add Copilot seats for their organization members. * * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * * The response will contain the total number of new seats that were created and existing seats that were refreshed. * @@ -3038,17 +3283,19 @@ export type paths = { /** * Remove users from the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Cancels the Copilot seat assignment for each user specified. - * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Sets seats for all users specified to "pending cancellation". + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * + * The response will contain the total number of seats set to "pending cancellation". + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ readonly delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; @@ -3057,6 +3304,38 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/copilot/metrics": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get Copilot metrics for an organization + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + * Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + readonly get: operations["copilot/copilot-metrics-for-organization"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/copilot/usage": { readonly parameters: { readonly query?: never; @@ -3067,7 +3346,7 @@ export type paths = { /** * Get a summary of Copilot usage for organization members * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -3534,6 +3813,186 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get route stats by actor + * @description Get API request count statistics for an actor broken down by route within a specified time frame. + */ + readonly get: operations["api-insights/get-route-stats-by-actor"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/subject-stats": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get subject stats + * @description Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + */ + readonly get: operations["api-insights/get-subject-stats"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/summary-stats": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get summary stats + * @description Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + */ + readonly get: operations["api-insights/get-summary-stats"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get summary stats by user + * @description Get overall statistics of API requests within the organization for a user. + */ + readonly get: operations["api-insights/get-summary-stats-by-user"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get summary stats by actor + * @description Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + */ + readonly get: operations["api-insights/get-summary-stats-by-actor"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/time-stats": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get time stats + * @description Get the number of API requests and rate-limited requests made within an organization over a specified time period. + */ + readonly get: operations["api-insights/get-time-stats"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/time-stats/users/{user_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get time stats by user + * @description Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + */ + readonly get: operations["api-insights/get-time-stats-by-user"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get time stats by actor + * @description Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + */ + readonly get: operations["api-insights/get-time-stats-by-actor"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/user-stats/{user_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get user stats + * @description Get API usage statistics within an organization for a user broken down by the type of access. + */ + readonly get: operations["api-insights/get-user-stats"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/installation": { readonly parameters: { readonly query?: never; @@ -3831,9 +4290,12 @@ export type paths = { /** * Get Copilot seat assignment details for a user * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + * + * The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * * Only organization owners can view Copilot seat assignment details for members of their organization. * @@ -4272,7 +4734,7 @@ export type paths = { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/list-packages-for-organization"]; readonly put?: never; @@ -4294,7 +4756,7 @@ export type paths = { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-for-organization"]; readonly put?: never; @@ -4305,7 +4767,7 @@ export type paths = { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-for-org"]; readonly options?: never; @@ -4332,7 +4794,7 @@ export type paths = { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-for-org"]; readonly delete?: never; @@ -4352,7 +4814,7 @@ export type paths = { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; readonly put?: never; @@ -4374,7 +4836,7 @@ export type paths = { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-version-for-organization"]; readonly put?: never; @@ -4385,7 +4847,7 @@ export type paths = { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-version-for-org"]; readonly options?: never; @@ -4412,7 +4874,7 @@ export type paths = { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-version-for-org"]; readonly delete?: never; @@ -5041,6 +5503,38 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/team/{team_slug}/copilot/metrics": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get Copilot metrics for a team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + * Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + readonly get: operations["copilot/copilot-metrics-for-team"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/team/{team_slug}/copilot/usage": { readonly parameters: { readonly query?: never; @@ -5051,7 +5545,7 @@ export type paths = { /** * Get a summary of Copilot usage for a team * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -5689,7 +6183,7 @@ export type paths = { * Enable or disable a security feature for an organization * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). * * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -5949,7 +6443,7 @@ export type paths = { * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." * * > [!NOTE] - * > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ readonly get: operations["rate-limit/get"]; readonly put?: never; @@ -8355,7 +8849,7 @@ export type paths = { * and `0` is returned in this field. * * > [!WARNING] - * > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -8482,7 +8976,7 @@ export type paths = { * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ readonly get: operations["code-scanning/list-codeql-databases"]; readonly put?: never; @@ -8510,12 +9004,18 @@ export type paths = { * your HTTP client is configured to follow redirects or use the `Location` header * to make a second request to get the redirect URL. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ readonly get: operations["code-scanning/get-codeql-database"]; readonly put?: never; readonly post?: never; - readonly delete?: never; + /** + * Delete a CodeQL database + * @description Deletes a CodeQL database for a language in a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + readonly delete: operations["code-scanning/delete-codeql-database"]; readonly options?: never; readonly head?: never; readonly patch?: never; @@ -8894,8 +9394,6 @@ export type paths = { * @description Gets your public key, which you need to encrypt secrets. You need to * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. - * * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["codespaces/get-repo-public-key"]; @@ -11038,7 +11536,7 @@ export type paths = { * @description View the progress of an import. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -11082,7 +11580,7 @@ export type paths = { * return a status `422 Unprocessable Entity` response. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly put: operations["migrations/start-import"]; readonly post?: never; @@ -11092,7 +11590,7 @@ export type paths = { * @description Stop an import for a repository. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly delete: operations["migrations/cancel-import"]; readonly options?: never; @@ -11108,7 +11606,7 @@ export type paths = { * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly patch: operations["migrations/update-import"]; readonly trace?: never; @@ -11128,7 +11626,7 @@ export type paths = { * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly get: operations["migrations/get-commit-authors"]; readonly put?: never; @@ -11159,7 +11657,7 @@ export type paths = { * new commits to the repository. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly patch: operations["migrations/map-commit-author"]; readonly trace?: never; @@ -11177,7 +11675,7 @@ export type paths = { * @description List files larger than 100MB found during the import * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly get: operations["migrations/get-large-files"]; readonly put?: never; @@ -11211,7 +11709,7 @@ export type paths = { * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly patch: operations["migrations/set-lfs-preference"]; readonly trace?: never; @@ -11540,7 +12038,7 @@ export type paths = { readonly head?: never; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12638,7 +13136,7 @@ export type paths = { * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." @@ -12991,6 +13489,7 @@ export type paths = { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ readonly put: operations["pulls/update-branch"]; readonly post?: never; @@ -13885,10 +14384,10 @@ export type paths = { readonly cookie?: never; }; /** - * Deprecated - List tag protection states for a repository + * Closing down - List tag protection states for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. * * This returns the tag protection states of a repository. * @@ -13897,10 +14396,10 @@ export type paths = { readonly get: operations["repos/list-tag-protection"]; readonly put?: never; /** - * Deprecated - Create a tag protection state for a repository + * Closing down - Create a tag protection state for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. * * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13923,10 +14422,10 @@ export type paths = { readonly put?: never; readonly post?: never; /** - * Deprecated - Delete a tag protection state for a repository + * Closing down - Delete a tag protection state for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. * * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -14428,7 +14927,7 @@ export type paths = { * Get a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ readonly get: operations["teams/get-legacy"]; readonly put?: never; @@ -14437,7 +14936,7 @@ export type paths = { * Delete a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -14450,7 +14949,7 @@ export type paths = { * Update a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * @@ -14471,7 +14970,7 @@ export type paths = { * List discussions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -14483,7 +14982,7 @@ export type paths = { * Create a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * @@ -14509,7 +15008,7 @@ export type paths = { * Get a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -14522,7 +15021,7 @@ export type paths = { * Delete a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -14535,7 +15034,7 @@ export type paths = { * Update a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -14555,7 +15054,7 @@ export type paths = { * List discussion comments (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -14567,7 +15066,7 @@ export type paths = { * Create a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * @@ -14593,7 +15092,7 @@ export type paths = { * Get a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -14606,7 +15105,7 @@ export type paths = { * Delete a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -14619,7 +15118,7 @@ export type paths = { * Update a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -14639,7 +15138,7 @@ export type paths = { * List reactions for a team discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14651,7 +15150,7 @@ export type paths = { * Create reaction for a team discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14677,7 +15176,7 @@ export type paths = { * List reactions for a team discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14689,7 +15188,7 @@ export type paths = { * Create reaction for a team discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14715,7 +15214,7 @@ export type paths = { * List pending team invitations (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ @@ -14739,7 +15238,7 @@ export type paths = { * List team members (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -14762,7 +15261,7 @@ export type paths = { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * @@ -14772,7 +15271,7 @@ export type paths = { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * @@ -14790,7 +15289,7 @@ export type paths = { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * @@ -14818,7 +15317,7 @@ export type paths = { * Get team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -14834,7 +15333,7 @@ export type paths = { * Add or update team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -14853,7 +15352,7 @@ export type paths = { * Remove team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -14879,7 +15378,7 @@ export type paths = { * List team projects (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -14903,7 +15402,7 @@ export type paths = { * Check team permissions for a project (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -14912,7 +15411,7 @@ export type paths = { * Add or update team project permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -14922,7 +15421,7 @@ export type paths = { * Remove a project from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -14943,7 +15442,7 @@ export type paths = { * List team repositories (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ readonly get: operations["teams/list-repos-legacy"]; readonly put?: never; @@ -14965,7 +15464,7 @@ export type paths = { * Check team permissions for a repository (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * * > [!NOTE] * > Repositories inherited through a parent team will also be checked. @@ -14977,7 +15476,7 @@ export type paths = { * Add or update team repository permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -14989,7 +15488,7 @@ export type paths = { * Remove a repository from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -15010,7 +15509,7 @@ export type paths = { * List child teams (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ readonly get: operations["teams/list-child-legacy"]; readonly put?: never; @@ -16068,6 +16567,9 @@ export type paths = { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ readonly get: operations["orgs/list-for-authenticated-user"]; readonly put?: never; @@ -16089,7 +16591,7 @@ export type paths = { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/list-packages-for-authenticated-user"]; readonly put?: never; @@ -16111,7 +16613,7 @@ export type paths = { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-for-authenticated-user"]; readonly put?: never; @@ -16120,7 +16622,7 @@ export type paths = { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-for-authenticated-user"]; readonly options?: never; @@ -16145,7 +16647,7 @@ export type paths = { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-for-authenticated-user"]; readonly delete?: never; @@ -16165,7 +16667,7 @@ export type paths = { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; readonly put?: never; @@ -16187,7 +16689,7 @@ export type paths = { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-version-for-authenticated-user"]; readonly put?: never; @@ -16198,7 +16700,7 @@ export type paths = { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-version-for-authenticated-user"]; readonly options?: never; @@ -16223,7 +16725,7 @@ export type paths = { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-version-for-authenticated-user"]; readonly delete?: never; @@ -16652,7 +17154,7 @@ export type paths = { }; /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). * * > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. @@ -16906,7 +17408,7 @@ export type paths = { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/list-packages-for-user"]; readonly put?: never; @@ -16928,7 +17430,7 @@ export type paths = { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-for-user"]; readonly put?: never; @@ -16939,7 +17441,7 @@ export type paths = { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-for-user"]; readonly options?: never; @@ -16966,7 +17468,7 @@ export type paths = { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-for-user"]; readonly delete?: never; @@ -16986,7 +17488,7 @@ export type paths = { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; readonly put?: never; @@ -17008,7 +17510,7 @@ export type paths = { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-version-for-user"]; readonly put?: never; @@ -17019,7 +17521,7 @@ export type paths = { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-version-for-user"]; readonly options?: never; @@ -17046,7 +17548,7 @@ export type paths = { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-version-for-user"]; readonly delete?: never; @@ -17516,6 +18018,8 @@ export type components = { readonly site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ readonly starred_at?: string; + /** @example public */ + readonly user_view_type?: string; }; /** * @description The type of credit the user is receiving. @@ -17710,6 +18214,8 @@ export type components = { readonly site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ readonly starred_at?: string; + /** @example public */ + readonly user_view_type?: string; } | null; /** * GitHub app @@ -18227,7 +18733,7 @@ export type components = { */ readonly organization_custom_properties?: "read" | "write" | "admin"; /** - * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. * @enum {string} */ readonly organization_copilot_seat_management?: "write"; @@ -18262,7 +18768,7 @@ export type components = { */ readonly organization_plan?: "read"; /** - * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). + * @description The level of permission to grant the access token to manage organization projects and projects public preview (where available). * @enum {string} */ readonly organization_projects?: "read" | "write" | "admin"; @@ -18706,7 +19212,7 @@ export type components = { readonly allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -19290,7 +19796,7 @@ export type components = { * Organization Simple * @description A GitHub organization. */ - readonly "organization-simple": { + readonly "nullable-organization-simple": { /** @example github */ readonly login: string; /** @example 1 */ @@ -19324,7 +19830,7 @@ export type components = { readonly avatar_url: string; /** @example A great organization */ readonly description: string | null; - }; + } | null; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -19433,8 +19939,8 @@ export type components = { readonly url: string; /** @example disabled | all */ readonly sync_to_organizations: string; - /** @example 1 */ - readonly group_id?: number | null; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + readonly group_id?: string | null; /** * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league @@ -19451,12 +19957,8 @@ export type components = { * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ readonly "copilot-seat-details": { - /** @description The assignee that has been granted access to GitHub Copilot. */ - readonly assignee: { - readonly [key: string]: unknown; - } & components["schemas"]["simple-user"]; - /** @description The organization to which this seat belongs. */ - readonly organization?: components["schemas"]["organization-simple"] | null; + readonly assignee: components["schemas"]["simple-user"]; + readonly organization?: components["schemas"]["nullable-organization-simple"]; /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ readonly assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; /** @@ -19481,6 +19983,157 @@ export type components = { * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. */ readonly updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + readonly plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + readonly "copilot-ide-code-completions": ({ + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description Code completion metrics for active languages. */ + readonly languages?: readonly { + /** @description Name of the language used for Copilot code completion suggestions. */ + readonly name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + }[]; + readonly editors?: readonly ({ + /** @description Name of the given editor. */ + readonly name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model. */ + readonly custom_model_training_date?: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description Code completion metrics for active languages, for the given editor. */ + readonly languages?: readonly { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + readonly name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + readonly total_code_suggestions?: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + readonly total_code_acceptances?: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + readonly total_code_lines_suggested?: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + readonly total_code_lines_accepted?: number; + }[]; + }[]; + } & { + readonly [key: string]: unknown; + })[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + readonly "copilot-ide-chat": ({ + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + readonly total_engaged_users?: number; + readonly editors?: readonly { + /** @description Name of the given editor. */ + readonly name?: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model. */ + readonly custom_model_training_date?: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + readonly total_engaged_users?: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + readonly total_chats?: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + readonly total_chat_insertion_events?: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + readonly total_chat_copy_events?: number; + }[]; + }[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in github.com */ + readonly "copilot-dotcom-chat": ({ + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for a custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model (if applicable). */ + readonly custom_model_training_date?: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + readonly total_engaged_users?: number; + /** @description Total number of chats initiated by users on github.com. */ + readonly total_chats?: number; + }[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot for pull requests. */ + readonly "copilot-dotcom-pull-requests": ({ + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + readonly total_engaged_users?: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + readonly repositories?: readonly { + /** @description Repository name */ + readonly name?: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model. */ + readonly custom_model_training_date?: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + readonly total_pr_summaries_created?: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + readonly total_engaged_users?: number; + }[]; + }[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + readonly "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + readonly date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + readonly total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + readonly total_engaged_users?: number; + readonly copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + readonly copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + readonly copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + readonly copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + } & { + readonly [key: string]: unknown; }; /** * Copilot Usage Metrics @@ -19991,6 +20644,10 @@ export type components = { * @enum {string} */ readonly validity?: "active" | "inactive" | "unknown"; + /** @description Whether the secret was publicly leaked. */ + readonly publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + readonly multi_repo?: boolean | null; }; /** * Actor @@ -20438,6 +21095,11 @@ export type components = { readonly language?: string; readonly raw_url?: string; readonly size?: number; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + readonly encoding: string; }; }; readonly public: boolean; @@ -20463,6 +21125,11 @@ export type components = { readonly login: string; /** Format: int64 */ readonly id: number; + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + readonly user_view_type: "public"; readonly node_id: string; /** Format: uri */ readonly avatar_url: string; @@ -20512,8 +21179,6 @@ export type components = { readonly space: number; readonly private_repos: number; }; - /** Format: date-time */ - readonly suspended_at?: string | null; /** @example 1 */ readonly private_gists?: number; /** @example 2 */ @@ -20620,6 +21285,11 @@ export type components = { readonly size?: number; readonly truncated?: boolean; readonly content?: string; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + readonly encoding: string; } | null; }; readonly public?: boolean; @@ -20988,6 +21658,10 @@ export type components = { /** @enum {string} */ readonly status?: "enabled" | "disabled"; }; + readonly secret_scanning_ai_detection?: { + /** @enum {string} */ + readonly status?: "enabled" | "disabled"; + }; } | null; /** * Minimal Repository @@ -21254,6 +21928,45 @@ export type components = { */ readonly repository_url?: string; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + readonly "organization-simple": { + /** @example github */ + readonly login: string; + /** @example 1 */ + readonly id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + readonly node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + readonly url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + readonly repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + readonly events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + readonly hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + readonly issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + readonly members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + readonly public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + readonly avatar_url: string; + /** @example A great organization */ + readonly description: string | null; + }; /** * Organization Full * @description Organization Full @@ -21339,7 +22052,12 @@ export type components = { readonly private_gists?: number | null; /** @example 10000 */ readonly disk_usage?: number | null; - /** @example 8 */ + /** + * @description The number of collaborators on private repositories. + * + * This field may be null if the number of private repositories is over 50,000. + * @example 8 + */ readonly collaborators?: number | null; /** * Format: email @@ -21378,7 +22096,7 @@ export type components = { readonly web_commit_signoff_required?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * @@ -21388,7 +22106,7 @@ export type components = { readonly advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * @@ -21398,7 +22116,7 @@ export type components = { readonly dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * @@ -21408,7 +22126,7 @@ export type components = { readonly dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * @@ -21418,7 +22136,7 @@ export type components = { readonly dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * @@ -21428,7 +22146,7 @@ export type components = { readonly secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * @@ -21455,6 +22173,11 @@ export type components = { readonly updated_at: string; /** Format: date-time */ readonly archived_at: string | null; + /** + * @description Controls whether or not deploy keys may be added and used for repositories in the organization. + * @example false + */ + readonly deploy_keys_enabled_for_repositories?: boolean; }; readonly "actions-cache-usage-org-enterprise": { /** @description The count of active caches across all repositories of an enterprise or an organization. */ @@ -21541,6 +22264,31 @@ export type components = { readonly default_workflow_permissions?: components["schemas"]["actions-default-workflow-permissions"]; readonly can_approve_pull_request_reviews?: components["schemas"]["actions-can-approve-pull-request-reviews"]; }; + readonly "runner-groups-org": { + readonly id: number; + readonly name: string; + readonly visibility: string; + readonly default: boolean; + /** @description Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ + readonly selected_repositories_url?: string; + readonly runners_url: string; + readonly hosted_runners_url?: string; + readonly inherited: boolean; + readonly inherited_allows_public_repositories?: boolean; + readonly allows_public_repositories: boolean; + /** + * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. + * @default false + */ + readonly workflow_restrictions_read_only: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + readonly restricted_to_workflows: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + readonly selected_workflows?: readonly string[]; + }; /** * Self hosted runner label * @description A label for a self hosted runner @@ -21741,9 +22489,9 @@ export type components = { readonly "alert-instances-url": string; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - readonly "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + readonly "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} @@ -21850,7 +22598,7 @@ export type components = { * @description The type of the code security configuration. * @enum {string} */ - readonly target_type?: "global" | "organization"; + readonly target_type?: "global" | "organization" | "enterprise"; /** @description A description of the code security configuration */ readonly description?: string; /** @@ -21898,6 +22646,24 @@ export type components = { * @enum {string} */ readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + readonly secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + readonly secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + readonly reviewers?: readonly { + /** @description The ID of the team or role selected as a bypass reviewer */ + readonly reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + readonly reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @enum {string} @@ -22225,8 +22991,8 @@ export type components = { readonly inactive_this_cycle?: number; }; /** - * Copilot Business Organization Details - * @description Information about the seat breakdown and policies set for an organization with a Copilot Business subscription. + * Copilot Organization Details + * @description Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription. */ readonly "copilot-organization-details": { readonly seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; @@ -22255,6 +23021,11 @@ export type components = { * @enum {string} */ readonly seat_management_setting: "assign_all" | "assign_selected" | "disabled" | "unconfigured"; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + readonly plan_type?: "business" | "enterprise" | "unknown"; } & { readonly [key: string]: unknown; }; @@ -22629,6 +23400,87 @@ export type components = { readonly created_at: string; readonly type: string; }; + /** + * Route Stats + * @description API Insights usage route stats for an actor + */ + readonly "api-insights-route-stats": readonly { + /** @description The HTTP method */ + readonly http_method?: string; + /** @description The API path's route template */ + readonly api_route?: string; + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + readonly total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + readonly rate_limited_request_count?: number; + readonly last_rate_limited_timestamp?: string | null; + readonly last_request_timestamp?: string; + }[]; + /** + * Subject Stats + * @description API Insights usage subject stats for an organization + */ + readonly "api-insights-subject-stats": readonly { + readonly subject_type?: string; + readonly subject_name?: string; + /** Format: int64 */ + readonly subject_id?: number; + readonly total_request_count?: number; + readonly rate_limited_request_count?: number; + readonly last_rate_limited_timestamp?: string | null; + readonly last_request_timestamp?: string; + }[]; + /** + * Summary Stats + * @description API Insights usage summary stats for an organization + */ + readonly "api-insights-summary-stats": { + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + readonly total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + readonly rate_limited_request_count?: number; + }; + /** + * Time Stats + * @description API Insights usage time stats for an organization + */ + readonly "api-insights-time-stats": readonly { + readonly timestamp?: string; + /** Format: int64 */ + readonly total_request_count?: number; + /** Format: int64 */ + readonly rate_limited_request_count?: number; + }[]; + /** + * User Stats + * @description API Insights usage stats for a user + */ + readonly "api-insights-user-stats": readonly { + readonly actor_type?: string; + readonly actor_name?: string; + /** Format: int64 */ + readonly actor_id?: number; + /** Format: int64 */ + readonly integration_id?: number | null; + /** Format: int64 */ + readonly oauth_application_id?: number | null; + readonly total_request_count?: number; + readonly rate_limited_request_count?: number; + readonly last_rate_limited_timestamp?: string | null; + readonly last_request_timestamp?: string; + }[]; /** * @description The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. * @example collaborators_only @@ -22933,6 +23785,8 @@ export type components = { readonly site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ readonly starred_at?: string; + /** @example public */ + readonly user_view_type?: string; }; /** * Package Version @@ -23021,6 +23875,10 @@ export type components = { }; /** @description Date and time when the request for access was created. */ readonly created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + readonly token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + readonly token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ readonly token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -23033,7 +23891,7 @@ export type components = { * @description Minimal representation of an organization programmatic access grant for enumerations */ readonly "organization-programmatic-access-grant": { - /** @description Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token. */ + /** @description Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. */ readonly id: number; readonly owner: components["schemas"]["simple-user"]; /** @@ -23057,6 +23915,10 @@ export type components = { }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ readonly access_granted_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + readonly token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + readonly token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ readonly token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -23485,7 +24347,7 @@ export type components = { readonly allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -23893,7 +24755,8 @@ export type components = { */ readonly actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. + * @default always * @enum {string} */ readonly bypass_mode: "always" | "pull_request"; @@ -23963,7 +24826,9 @@ export type components = { }; /** * Organization ruleset conditions - * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. + * @description Conditions for an organization ruleset. + * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + * The push rulesets conditions object does not require the `ref_name` property. */ readonly "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24052,6 +24917,18 @@ export type components = { /** @enum {string} */ readonly type: "required_signatures"; }; + /** + * RequiredReviewerConfiguration + * @description A reviewing team, and file patterns describing which files they must approve changes to. + */ + readonly "repository-rule-params-required-reviewer-configuration": { + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files. */ + readonly file_patterns: readonly string[]; + /** @description Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. */ + readonly minimum_approvals: number; + /** @description Node ID of the team which must review changes to matching files. */ + readonly reviewer_id: string; + }; /** * pull_request * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -24351,7 +25228,7 @@ export type components = { readonly html?: { /** @description The html URL of the ruleset */ readonly href?: string; - }; + } | null; }; readonly conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; readonly rules?: readonly components["schemas"]["repository-rule"][]; @@ -26462,6 +27339,7 @@ export type components = { readonly received_events_url?: string; readonly type?: string; readonly site_admin?: boolean; + readonly user_view_type?: string; }[]; readonly teams: readonly { readonly id?: number; @@ -26517,6 +27395,8 @@ export type components = { readonly type?: string; /** @example false */ readonly site_admin?: boolean; + /** @example public */ + readonly user_view_type?: string; }; readonly name?: string; readonly client_id?: string; @@ -27067,7 +27947,10 @@ export type components = { * @description A suite of checks performed on the code of a given code change */ readonly "check-suite": { - /** @example 5 */ + /** + * Format: int64 + * @example 5 + */ readonly id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ readonly node_id: string; @@ -27687,6 +28570,8 @@ export type components = { }; /** @example admin */ readonly role_name: string; + /** @example public */ + readonly user_view_type?: string; }; /** * Repository Invitation @@ -27802,6 +28687,8 @@ export type components = { }; /** @example admin */ readonly role_name: string; + /** @example public */ + readonly user_view_type?: string; } | null; /** * Repository Collaborator Permission @@ -28175,6 +29062,7 @@ export type components = { readonly name: string; readonly path: string; readonly sha: string; + readonly content?: string; /** Format: uri */ readonly url: string; /** Format: uri */ @@ -28188,7 +29076,6 @@ export type components = { readonly size: number; readonly name: string; readonly path: string; - readonly content?: string; readonly sha: string; /** Format: uri */ readonly url: string; @@ -28250,7 +29137,10 @@ export type components = { * @description Content File */ readonly "content-file": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ readonly type: "file"; readonly encoding: string; readonly size: number; @@ -28284,7 +29174,10 @@ export type components = { * @description An object describing a symlink */ readonly "content-symlink": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ readonly type: "symlink"; readonly target: string; readonly size: number; @@ -28313,7 +29206,10 @@ export type components = { * @description An object describing a submodule */ readonly "content-submodule": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ readonly type: "submodule"; /** Format: uri */ readonly submodule_git_url: string; @@ -28442,6 +29338,7 @@ export type components = { readonly contributions: number; readonly email?: string; readonly name?: string; + readonly user_view_type?: string; }; /** @description A Dependabot alert. */ readonly "dependabot-alert": { @@ -28548,6 +29445,11 @@ export type components = { * @example SPDX-2.3 */ readonly spdxVersion: string; + /** + * @description An optional comment about the SPDX document. + * @example Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/ + */ + readonly comment?: string; readonly creationInfo: { /** * @description The date and time the SPDX document was created. @@ -28567,11 +29469,9 @@ export type components = { * @example CC0-1.0 */ readonly dataLicense: string; - /** @description The name of the repository that the SPDX document describes. */ - readonly documentDescribes: readonly string[]; /** * @description The namespace for the SPDX document. - * @example https://github.com/example/dependency_graph/sbom-123 + * @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 */ readonly documentNamespace: string; readonly packages: readonly { @@ -28582,7 +29482,7 @@ export type components = { readonly SPDXID?: string; /** * @description The name of the package. - * @example rubygems:github/github + * @example github/github */ readonly name?: string; /** @@ -28642,6 +29542,17 @@ export type components = { readonly referenceType: string; }[]; }[]; + readonly relationships?: readonly { + /** + * @description The type of relationship between the two SPDX elements. + * @example DEPENDS_ON + */ + readonly relationshipType?: string; + /** @description The SPDX identifier of the package that is the source of the relationship. */ + readonly spdxElementId?: string; + /** @description The SPDX identifier of the package that is the target of the relationship. */ + readonly relatedSpdxElement?: string; + }[]; }; }; /** @@ -28797,7 +29708,7 @@ export type components = { readonly environment: string; /** * Format: uri - * @description Deprecated: the URL to associate with this status. + * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ @@ -30159,12 +31070,12 @@ export type components = { */ readonly path: string; /** - * @description The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. + * @description The line index in the diff to which the comment applies. This field is closing down; use `line` instead. * @example 1 */ readonly position?: number; /** - * @description The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. + * @description The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. * @example 4 */ readonly original_position?: number; @@ -30364,6 +31275,7 @@ export type components = { readonly read_only: boolean; readonly added_by?: string | null; readonly last_used?: string | null; + readonly enabled?: boolean; }; /** * Language @@ -30824,361 +31736,16 @@ export type components = { readonly head: { readonly label: string; readonly ref: string; - readonly repo: { - readonly archive_url: string; - readonly assignees_url: string; - readonly blobs_url: string; - readonly branches_url: string; - readonly collaborators_url: string; - readonly comments_url: string; - readonly commits_url: string; - readonly compare_url: string; - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - readonly git_commits_url: string; - readonly git_refs_url: string; - readonly git_tags_url: string; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly issue_comment_url: string; - readonly issue_events_url: string; - readonly issues_url: string; - readonly keys_url: string; - readonly labels_url: string; - /** Format: uri */ - readonly languages_url: string; - /** Format: uri */ - readonly merges_url: string; - readonly milestones_url: string; - readonly name: string; - readonly notifications_url: string; - readonly owner: { - /** Format: uri */ - readonly avatar_url: string; - readonly events_url: string; - /** Format: uri */ - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string | null; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly login: string; - /** Format: uri */ - readonly organizations_url: string; - /** Format: uri */ - readonly received_events_url: string; - /** Format: uri */ - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - /** Format: uri */ - readonly subscriptions_url: string; - readonly type: string; - /** Format: uri */ - readonly url: string; - }; - readonly private: boolean; - readonly pulls_url: string; - readonly releases_url: string; - /** Format: uri */ - readonly stargazers_url: string; - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly trees_url: string; - /** Format: uri */ - readonly url: string; - readonly clone_url: string; - readonly default_branch: string; - readonly forks: number; - readonly forks_count: number; - readonly git_url: string; - readonly has_downloads: boolean; - readonly has_issues: boolean; - readonly has_projects: boolean; - readonly has_wiki: boolean; - readonly has_pages: boolean; - readonly has_discussions: boolean; - /** Format: uri */ - readonly homepage: string | null; - readonly language: string | null; - readonly master_branch?: string; - readonly archived: boolean; - readonly disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - readonly visibility?: string; - /** Format: uri */ - readonly mirror_url: string | null; - readonly open_issues: number; - readonly open_issues_count: number; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly push: boolean; - readonly triage?: boolean; - readonly pull: boolean; - }; - readonly temp_clone_token?: string; - readonly allow_merge_commit?: boolean; - readonly allow_squash_merge?: boolean; - readonly allow_rebase_merge?: boolean; - readonly license: { - readonly key: string; - readonly name: string; - /** Format: uri */ - readonly url: string | null; - readonly spdx_id: string | null; - readonly node_id: string; - } | null; - /** Format: date-time */ - readonly pushed_at: string; - readonly size: number; - readonly ssh_url: string; - readonly stargazers_count: number; - /** Format: uri */ - readonly svn_url: string; - readonly topics?: readonly string[]; - readonly watchers: number; - readonly watchers_count: number; - /** Format: date-time */ - readonly created_at: string; - /** Format: date-time */ - readonly updated_at: string; - readonly allow_forking?: boolean; - readonly is_template?: boolean; - readonly web_commit_signoff_required?: boolean; - } | null; + readonly repo: components["schemas"]["repository"]; readonly sha: string; - readonly user: { - /** Format: uri */ - readonly avatar_url: string; - readonly events_url: string; - /** Format: uri */ - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string | null; - /** Format: uri */ - readonly html_url: string; - /** Format: int64 */ - readonly id: number; - readonly node_id: string; - readonly login: string; - /** Format: uri */ - readonly organizations_url: string; - /** Format: uri */ - readonly received_events_url: string; - /** Format: uri */ - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - /** Format: uri */ - readonly subscriptions_url: string; - readonly type: string; - /** Format: uri */ - readonly url: string; - }; + readonly user: components["schemas"]["simple-user"]; }; readonly base: { readonly label: string; readonly ref: string; - readonly repo: { - readonly archive_url: string; - readonly assignees_url: string; - readonly blobs_url: string; - readonly branches_url: string; - readonly collaborators_url: string; - readonly comments_url: string; - readonly commits_url: string; - readonly compare_url: string; - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - readonly git_commits_url: string; - readonly git_refs_url: string; - readonly git_tags_url: string; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly is_template?: boolean; - readonly node_id: string; - readonly issue_comment_url: string; - readonly issue_events_url: string; - readonly issues_url: string; - readonly keys_url: string; - readonly labels_url: string; - /** Format: uri */ - readonly languages_url: string; - /** Format: uri */ - readonly merges_url: string; - readonly milestones_url: string; - readonly name: string; - readonly notifications_url: string; - readonly owner: { - /** Format: uri */ - readonly avatar_url: string; - readonly events_url: string; - /** Format: uri */ - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string | null; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly login: string; - /** Format: uri */ - readonly organizations_url: string; - /** Format: uri */ - readonly received_events_url: string; - /** Format: uri */ - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - /** Format: uri */ - readonly subscriptions_url: string; - readonly type: string; - /** Format: uri */ - readonly url: string; - }; - readonly private: boolean; - readonly pulls_url: string; - readonly releases_url: string; - /** Format: uri */ - readonly stargazers_url: string; - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly trees_url: string; - /** Format: uri */ - readonly url: string; - readonly clone_url: string; - readonly default_branch: string; - readonly forks: number; - readonly forks_count: number; - readonly git_url: string; - readonly has_downloads: boolean; - readonly has_issues: boolean; - readonly has_projects: boolean; - readonly has_wiki: boolean; - readonly has_pages: boolean; - readonly has_discussions: boolean; - /** Format: uri */ - readonly homepage: string | null; - readonly language: string | null; - readonly master_branch?: string; - readonly archived: boolean; - readonly disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - readonly visibility?: string; - /** Format: uri */ - readonly mirror_url: string | null; - readonly open_issues: number; - readonly open_issues_count: number; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly push: boolean; - readonly triage?: boolean; - readonly pull: boolean; - }; - readonly temp_clone_token?: string; - readonly allow_merge_commit?: boolean; - readonly allow_squash_merge?: boolean; - readonly allow_rebase_merge?: boolean; - readonly license: components["schemas"]["nullable-license-simple"]; - /** Format: date-time */ - readonly pushed_at: string; - readonly size: number; - readonly ssh_url: string; - readonly stargazers_count: number; - /** Format: uri */ - readonly svn_url: string; - readonly topics?: readonly string[]; - readonly watchers: number; - readonly watchers_count: number; - /** Format: date-time */ - readonly created_at: string; - /** Format: date-time */ - readonly updated_at: string; - readonly allow_forking?: boolean; - readonly web_commit_signoff_required?: boolean; - }; + readonly repo: components["schemas"]["repository"]; readonly sha: string; - readonly user: { - /** Format: uri */ - readonly avatar_url: string; - readonly events_url: string; - /** Format: uri */ - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string | null; - /** Format: uri */ - readonly html_url: string; - /** Format: int64 */ - readonly id: number; - readonly node_id: string; - readonly login: string; - /** Format: uri */ - readonly organizations_url: string; - /** Format: uri */ - readonly received_events_url: string; - /** Format: uri */ - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - /** Format: uri */ - readonly subscriptions_url: string; - readonly type: string; - /** Format: uri */ - readonly url: string; - }; + readonly user: components["schemas"]["simple-user"]; }; readonly _links: { readonly comments: components["schemas"]["link"]; @@ -31552,6 +32119,10 @@ export type components = { * @enum {string} */ readonly validity?: "active" | "inactive" | "unknown"; + /** @description Whether the detected secret was publicly leaked. */ + readonly publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + readonly multi_repo?: boolean | null; }; /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ readonly "secret-scanning-alert-resolution-comment": string | null; @@ -32446,6 +33017,7 @@ export type components = { readonly company?: string | null; /** Format: date-time */ readonly suspended_at?: string | null; + readonly user_view_type?: string; }; /** * Private User @@ -32459,6 +33031,11 @@ export type components = { * @example 1 */ readonly id: number; + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + readonly user_view_type: "private"; /** @example MDQ6VXNlcjE= */ readonly node_id: string; /** @@ -32573,8 +33150,6 @@ export type components = { readonly space: number; readonly private_repos: number; }; - /** Format: date-time */ - readonly suspended_at?: string | null; readonly business_plus?: boolean; readonly ldap_dn?: string; }; @@ -33614,7 +34189,7 @@ export type components = { readonly allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -33675,75 +34250,6 @@ export type components = { /** @description Whether anonymous git access is enabled for this repository */ readonly anonymous_access_enabled?: boolean; }; - /** - * Simple User - * @description The GitHub user that triggered the event. This property is included in every webhook payload. - */ - readonly "simple-user-webhooks": { - readonly name?: string | null; - readonly email?: string | null; - /** @example octocat */ - readonly login: string; - /** @example 1 */ - readonly id: number; - /** @example MDQ6VXNlcjE= */ - readonly node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; - /** - * Format: uri - * @example https://api.github.com/users/octocat - */ - readonly url: string; - /** - * Format: uri - * @example https://github.com/octocat - */ - readonly html_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/followers - */ - readonly followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions - */ - readonly subscriptions_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs - */ - readonly organizations_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/repos - */ - readonly repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events - */ - readonly received_events_url: string; - /** @example User */ - readonly type: string; - readonly site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - readonly starred_at?: string; - }; /** * branch protection rule * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. @@ -33916,6 +34422,7 @@ export type components = { /** Format: uri */ readonly url: string; readonly verified: boolean; + readonly enabled?: boolean; }; /** Workflow */ readonly webhooks_workflow: { @@ -33954,6 +34461,7 @@ export type components = { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly webhooks_reviewers: readonly { /** User */ @@ -34043,6 +34551,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly webhooks_answer: { /** @@ -34114,6 +34623,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** @@ -34159,6 +34669,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly answer_html_url: string | null; /** @@ -34258,6 +34769,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly labels?: readonly components["schemas"]["label"][]; }; @@ -34329,6 +34841,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Label */ @@ -34458,6 +34971,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** @description The changes to the comment. */ @@ -34510,6 +35024,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -34546,6 +35061,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -34633,6 +35149,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -34715,6 +35232,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -34876,6 +35394,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** @@ -34924,6 +35443,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -34992,6 +35512,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -35028,6 +35549,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -35115,6 +35637,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -35197,6 +35720,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -35358,6 +35882,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** User */ @@ -35396,6 +35921,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Marketplace Purchase */ readonly webhooks_marketplace_purchase: { @@ -35975,7 +36501,7 @@ export type components = { readonly allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -36082,6 +36608,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -36155,6 +36682,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** @@ -36221,6 +36749,10 @@ export type components = { }[] | null; /** @description Date and time when the request for access was created. */ readonly created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + readonly token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + readonly token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ readonly token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -36276,6 +36808,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The project card's ID */ readonly id: number; @@ -36332,6 +36865,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: uri */ readonly html_url: string; @@ -36551,7 +37085,7 @@ export type components = { */ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -36639,6 +37173,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -36727,6 +37262,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -36950,6 +37486,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -37059,6 +37596,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -37294,6 +37832,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -37403,6 +37942,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -37470,6 +38010,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -37517,6 +38058,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -37740,6 +38282,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** @@ -37886,6 +38429,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** @description The review that was affected. */ @@ -37959,6 +38503,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly webhooks_nullable_string: string | null; @@ -38065,6 +38610,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly body: string | null; /** Format: date-time */ @@ -38212,6 +38758,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly body: string | null; /** Format: date-time */ @@ -38361,6 +38908,10 @@ export type components = { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly push_protection_bypassed_at?: string | null; + /** @description Whether the detected secret was publicly leaked. */ + readonly publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + readonly multi_repo?: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ readonly webhooks_security_advisory: { @@ -38421,6 +38972,7 @@ export type components = { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly node_id: string; readonly privacy_level: string; @@ -38460,6 +39012,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** User */ readonly sponsorable: { @@ -38497,6 +39050,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Sponsorship Tier @@ -38608,7 +39162,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** branch protection configuration enabled event */ readonly "webhook-branch-protection-configuration-enabled": { @@ -38618,7 +39172,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** branch protection rule created event */ readonly "webhook-branch-protection-rule-created": { @@ -38629,7 +39183,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly rule: components["schemas"]["webhooks_rule"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ readonly "webhook-branch-protection-rule-deleted": { @@ -38640,7 +39194,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly rule: components["schemas"]["webhooks_rule"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ readonly "webhook-branch-protection-rule-edited": { @@ -38691,7 +39245,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly rule: components["schemas"]["webhooks_rule"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ readonly "webhook-check-run-completed": { @@ -38701,7 +39255,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event @@ -38719,7 +39273,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event @@ -38742,7 +39296,7 @@ export type components = { /** @description The integrator reference of the action requested by the user. */ readonly identifier?: string; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event @@ -38760,7 +39314,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event @@ -38834,6 +39388,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -39011,7 +39566,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** check_suite requested event */ readonly "webhook-check-suite-requested": { @@ -39077,6 +39632,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -39254,7 +39810,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** check_suite rerequested event */ readonly "webhook-check-suite-rerequested": { @@ -39320,6 +39876,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -39497,7 +40054,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert appeared_in_branch event */ readonly "webhook-code-scanning-alert-appeared-in-branch": { @@ -39551,6 +40108,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -39623,7 +40181,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ readonly "webhook-code-scanning-alert-closed-by-user": { @@ -39677,6 +40235,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -39756,7 +40315,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ readonly "webhook-code-scanning-alert-created": { @@ -39831,9 +40390,9 @@ export type components = { }; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - readonly state: "open" | "dismissed"; + readonly state: "open" | "dismissed" | null; readonly tool: { readonly guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -39851,7 +40410,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ readonly "webhook-code-scanning-alert-fixed": { @@ -39905,6 +40464,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -39986,7 +40546,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ readonly "webhook-code-scanning-alert-reopened": { @@ -40079,7 +40639,7 @@ export type components = { /** @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. */ readonly ref: string | null; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ readonly "webhook-code-scanning-alert-reopened-by-user": { @@ -40163,7 +40723,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** commit_comment created event */ readonly "webhook-commit-comment-created": { @@ -40172,7 +40732,7 @@ export type components = { * @enum {string} */ readonly action: "created"; - /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ + /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ readonly comment: { /** * AuthorAssociation @@ -40251,13 +40811,14 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** create event */ readonly "webhook-create": { @@ -40276,7 +40837,7 @@ export type components = { */ readonly ref_type: "tag" | "branch"; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** custom property created event */ readonly "webhook-custom-property-created": { @@ -40286,7 +40847,7 @@ export type components = { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** custom property deleted event */ readonly "webhook-custom-property-deleted": { @@ -40299,7 +40860,7 @@ export type components = { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** custom property updated event */ readonly "webhook-custom-property-updated": { @@ -40309,7 +40870,7 @@ export type components = { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** Custom property values updated event */ readonly "webhook-custom-property-values-updated": { @@ -40319,7 +40880,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; /** @description The new custom property values for the repository. */ readonly new_property_values: readonly components["schemas"]["custom-property-value"][]; /** @description The old custom property values for the repository. */ @@ -40338,7 +40899,7 @@ export type components = { */ readonly ref_type: "tag" | "branch"; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-dismissed event */ readonly "webhook-dependabot-alert-auto-dismissed": { @@ -40349,7 +40910,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-reopened event */ readonly "webhook-dependabot-alert-auto-reopened": { @@ -40360,7 +40921,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ readonly "webhook-dependabot-alert-created": { @@ -40371,7 +40932,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ readonly "webhook-dependabot-alert-dismissed": { @@ -40382,7 +40943,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ readonly "webhook-dependabot-alert-fixed": { @@ -40393,7 +40954,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ readonly "webhook-dependabot-alert-reintroduced": { @@ -40404,7 +40965,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ readonly "webhook-dependabot-alert-reopened": { @@ -40415,7 +40976,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ readonly "webhook-deploy-key-created": { @@ -40426,7 +40987,7 @@ export type components = { readonly key: components["schemas"]["webhooks_deploy_key"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ readonly "webhook-deploy-key-deleted": { @@ -40437,7 +40998,7 @@ export type components = { readonly key: components["schemas"]["webhooks_deploy_key"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** deployment created event */ readonly "webhook-deployment-created": { @@ -40485,6 +41046,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; readonly environment: string; @@ -40547,6 +41109,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -40643,7 +41206,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ readonly workflow_run: { @@ -40683,6 +41246,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly artifacts_url?: string; readonly cancel_url?: string; @@ -40917,6 +41481,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: date-time */ readonly updated_at: string; @@ -40944,7 +41509,7 @@ export type components = { readonly repository?: components["schemas"]["repository-webhooks"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; readonly "webhook-deployment-review-approved": { /** @enum {string} */ @@ -40956,7 +41521,7 @@ export type components = { readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly reviewers?: components["schemas"]["webhooks_reviewers"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly since: string; readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; readonly workflow_job_runs?: readonly { @@ -41007,6 +41572,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly artifacts_url?: string; readonly cancel_url?: string; @@ -41075,6 +41641,7 @@ export type components = { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly private?: boolean; readonly pulls_url?: string; @@ -41185,6 +41752,7 @@ export type components = { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly private?: boolean; readonly pulls_url?: string; @@ -41241,6 +41809,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: date-time */ readonly updated_at: string; @@ -41260,7 +41829,7 @@ export type components = { readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly reviewers?: components["schemas"]["webhooks_reviewers"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly since: string; readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; readonly workflow_job_runs?: readonly { @@ -41311,6 +41880,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly artifacts_url?: string; readonly cancel_url?: string; @@ -41378,6 +41948,7 @@ export type components = { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly private?: boolean; readonly pulls_url?: string; @@ -41488,6 +42059,7 @@ export type components = { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly private?: boolean; readonly pulls_url?: string; @@ -41544,6 +42116,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: date-time */ readonly updated_at: string; @@ -41600,11 +42173,12 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @enum {string} */ readonly type?: "User" | "Team"; }[]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly since: string; readonly workflow_job_run: { readonly conclusion: unknown; @@ -41654,6 +42228,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly artifacts_url?: string; readonly cancel_url?: string; @@ -41721,6 +42296,7 @@ export type components = { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly private?: boolean; readonly pulls_url?: string; @@ -41831,6 +42407,7 @@ export type components = { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly private?: boolean; readonly pulls_url?: string; @@ -41887,6 +42464,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: date-time */ readonly updated_at: string; @@ -41973,6 +42551,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; readonly environment: string; @@ -42035,6 +42614,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -42166,6 +42746,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: uri */ readonly deployment_url: string; @@ -42233,6 +42814,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -42326,7 +42908,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ readonly workflow_run?: { @@ -42366,6 +42948,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly artifacts_url?: string; readonly cancel_url?: string; @@ -42600,6 +43183,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: date-time */ readonly updated_at: string; @@ -42619,7 +43203,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion category changed event */ readonly "webhook-discussion-category-changed": { @@ -42647,7 +43231,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion closed event */ readonly "webhook-discussion-closed": { @@ -42658,7 +43242,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion_comment created event */ readonly "webhook-discussion-comment-created": { @@ -42670,7 +43254,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion_comment deleted event */ readonly "webhook-discussion-comment-deleted": { @@ -42682,7 +43266,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion_comment edited event */ readonly "webhook-discussion-comment-edited": { @@ -42699,7 +43283,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion created event */ readonly "webhook-discussion-created": { @@ -42710,7 +43294,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion deleted event */ readonly "webhook-discussion-deleted": { @@ -42721,7 +43305,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion edited event */ readonly "webhook-discussion-edited": { @@ -42740,7 +43324,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion labeled event */ readonly "webhook-discussion-labeled": { @@ -42752,7 +43336,7 @@ export type components = { readonly label: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ readonly "webhook-discussion-locked": { @@ -42763,7 +43347,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion pinned event */ readonly "webhook-discussion-pinned": { @@ -42774,7 +43358,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion reopened event */ readonly "webhook-discussion-reopened": { @@ -42785,7 +43369,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion transferred event */ readonly "webhook-discussion-transferred": { @@ -42800,7 +43384,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion unanswered event */ readonly "webhook-discussion-unanswered": { @@ -42810,7 +43394,7 @@ export type components = { readonly old_answer: components["schemas"]["webhooks_answer"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ readonly "webhook-discussion-unlabeled": { @@ -42822,7 +43406,7 @@ export type components = { readonly label: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ readonly "webhook-discussion-unlocked": { @@ -42833,7 +43417,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion unpinned event */ readonly "webhook-discussion-unpinned": { @@ -42844,7 +43428,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** * fork event @@ -43040,6 +43624,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -43191,13 +43776,13 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ readonly "webhook-github-app-authorization-revoked": { /** @enum {string} */ readonly action: "revoked"; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** gollum event */ readonly "webhook-gollum": { @@ -43225,7 +43810,7 @@ export type components = { readonly title: string; }[]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** installation created event */ readonly "webhook-installation-created": { @@ -43237,7 +43822,7 @@ export type components = { readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly requester?: components["schemas"]["webhooks_user"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ readonly "webhook-installation-deleted": { @@ -43249,7 +43834,7 @@ export type components = { readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ readonly "webhook-installation-new-permissions-accepted": { @@ -43261,7 +43846,7 @@ export type components = { readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ readonly "webhook-installation-repositories-added": { @@ -43285,7 +43870,7 @@ export type components = { readonly repository?: components["schemas"]["repository-webhooks"]; readonly repository_selection: components["schemas"]["webhooks_repository_selection"]; readonly requester: components["schemas"]["webhooks_user"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ readonly "webhook-installation-repositories-removed": { @@ -43309,7 +43894,7 @@ export type components = { readonly repository?: components["schemas"]["repository-webhooks"]; readonly repository_selection: components["schemas"]["webhooks_repository_selection"]; readonly requester: components["schemas"]["webhooks_user"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ readonly "webhook-installation-suspend": { @@ -43321,7 +43906,7 @@ export type components = { readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; readonly "webhook-installation-target-renamed": { readonly account: { @@ -43361,6 +43946,7 @@ export type components = { readonly updated_at?: string; readonly url?: string; readonly website_url?: unknown; + readonly user_view_type?: string; }; /** @enum {string} */ readonly action: "renamed"; @@ -43376,7 +43962,7 @@ export type components = { readonly installation: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; readonly target_type: string; }; /** installation unsuspend event */ @@ -43389,7 +43975,7 @@ export type components = { readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ readonly "webhook-issue-comment-created": { @@ -43479,6 +44065,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -43523,6 +44110,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -43559,6 +44147,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -43646,6 +44235,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -43728,6 +44318,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -43889,6 +44480,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; } & { readonly active_lock_reason?: string | null; @@ -43928,6 +44520,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees?: readonly Record[]; readonly author_association?: string; @@ -44006,7 +44599,7 @@ export type components = { }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ readonly "webhook-issue-comment-deleted": { @@ -44055,6 +44648,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -44091,6 +44685,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -44178,6 +44773,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -44260,6 +44856,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -44421,6 +45018,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; } & { readonly active_lock_reason?: string | null; @@ -44460,6 +45058,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees?: readonly Record[]; readonly author_association?: string; @@ -44534,11 +45133,12 @@ export type components = { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issue_comment edited event */ readonly "webhook-issue-comment-edited": { @@ -44588,6 +45188,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -44624,6 +45225,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -44711,6 +45313,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -44793,6 +45396,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -44954,6 +45558,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; } & { readonly active_lock_reason?: string | null; @@ -44993,6 +45598,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees?: readonly Record[]; readonly author_association?: string; @@ -45071,7 +45677,7 @@ export type components = { }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues assigned event */ readonly "webhook-issues-assigned": { @@ -45086,7 +45692,7 @@ export type components = { readonly issue: components["schemas"]["webhooks_issue"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues closed event */ readonly "webhook-issues-closed": { @@ -45137,6 +45743,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -45173,6 +45780,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -45260,6 +45868,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -45342,6 +45951,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -45503,6 +46113,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; } & { readonly active_lock_reason?: string | null; @@ -45563,11 +46174,12 @@ export type components = { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues deleted event */ readonly "webhook-issues-deleted": { @@ -45618,6 +46230,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -45741,6 +46354,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -45823,6 +46437,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -45984,11 +46599,12 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues demilestoned event */ readonly "webhook-issues-demilestoned": { @@ -46162,6 +46778,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -46244,6 +46861,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -46405,12 +47023,13 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly milestone?: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues edited event */ readonly "webhook-issues-edited": { @@ -46472,6 +47091,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -46595,6 +47215,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -46677,6 +47298,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -46838,12 +47460,13 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly label?: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues labeled event */ readonly "webhook-issues-labeled": { @@ -46894,6 +47517,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -47017,6 +47641,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -47099,6 +47724,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -47260,12 +47886,13 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly label?: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues locked event */ readonly "webhook-issues-locked": { @@ -47316,6 +47943,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -47352,6 +47980,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47440,6 +48069,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -47522,6 +48152,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -47683,11 +48314,12 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ readonly "webhook-issues-milestoned": { @@ -47861,6 +48493,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -47943,6 +48576,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -48104,12 +48738,13 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly milestone: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues opened event */ readonly "webhook-issues-opened": { @@ -48159,6 +48794,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -48195,6 +48831,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48282,6 +48919,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -48364,6 +49002,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -48525,6 +49164,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; } | null; /** @@ -48724,6 +49364,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -48819,6 +49460,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -48855,6 +49497,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48942,6 +49585,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -49024,6 +49668,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -49185,11 +49830,12 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ readonly "webhook-issues-pinned": { @@ -49200,7 +49846,7 @@ export type components = { readonly issue: components["schemas"]["webhooks_issue_2"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ readonly "webhook-issues-reopened": { @@ -49374,6 +50020,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -49456,6 +50103,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -49617,11 +50265,12 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ readonly "webhook-issues-transferred": { @@ -49671,6 +50320,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -49707,6 +50357,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -49794,6 +50445,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -49876,6 +50528,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -50037,6 +50690,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** @@ -50239,6 +50893,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -50294,7 +50949,7 @@ export type components = { readonly issue: components["schemas"]["webhooks_issue_2"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ readonly "webhook-issues-unassigned": { @@ -50309,7 +50964,7 @@ export type components = { readonly issue: components["schemas"]["webhooks_issue"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ readonly "webhook-issues-unlabeled": { @@ -50321,7 +50976,7 @@ export type components = { readonly label?: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ readonly "webhook-issues-unlocked": { @@ -50372,6 +51027,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -50408,6 +51064,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -50496,6 +51153,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -50578,6 +51236,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -50739,11 +51398,12 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ readonly "webhook-issues-unpinned": { @@ -50754,7 +51414,7 @@ export type components = { readonly issue: components["schemas"]["webhooks_issue_2"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** label created event */ readonly "webhook-label-created": { @@ -50765,7 +51425,7 @@ export type components = { readonly label: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ readonly "webhook-label-deleted": { @@ -50776,7 +51436,7 @@ export type components = { readonly label: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** label edited event */ readonly "webhook-label-edited": { @@ -50802,7 +51462,7 @@ export type components = { readonly label: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase cancelled event */ readonly "webhook-marketplace-purchase-cancelled": { @@ -50815,7 +51475,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase changed event */ readonly "webhook-marketplace-purchase-changed": { @@ -50854,7 +51514,7 @@ export type components = { readonly unit_count: number; }; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change event */ readonly "webhook-marketplace-purchase-pending-change": { @@ -50893,7 +51553,7 @@ export type components = { readonly unit_count: number; }; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change_cancelled event */ readonly "webhook-marketplace-purchase-pending-change-cancelled": { @@ -50932,7 +51592,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase purchased event */ readonly "webhook-marketplace-purchase-purchased": { @@ -50945,7 +51605,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** member added event */ readonly "webhook-member-added": { @@ -50970,7 +51630,7 @@ export type components = { readonly member: components["schemas"]["webhooks_user"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** member edited event */ readonly "webhook-member-edited": { @@ -50992,7 +51652,7 @@ export type components = { readonly member: components["schemas"]["webhooks_user"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** member removed event */ readonly "webhook-member-removed": { @@ -51003,7 +51663,7 @@ export type components = { readonly member: components["schemas"]["webhooks_user"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** membership added event */ readonly "webhook-membership-added": { @@ -51055,6 +51715,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly team: components["schemas"]["webhooks_team"]; }; @@ -51108,6 +51769,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly team: components["schemas"]["webhooks_team"]; }; @@ -51118,7 +51780,7 @@ export type components = { readonly merge_group: components["schemas"]["merge-group"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; readonly "webhook-merge-group-destroyed": { /** @enum {string} */ @@ -51132,7 +51794,7 @@ export type components = { readonly merge_group: components["schemas"]["merge-group"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** meta deleted event */ readonly "webhook-meta-deleted": { @@ -51162,7 +51824,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ readonly "webhook-milestone-closed": { @@ -51173,7 +51835,7 @@ export type components = { readonly milestone: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** milestone created event */ readonly "webhook-milestone-created": { @@ -51184,7 +51846,7 @@ export type components = { readonly milestone: components["schemas"]["webhooks_milestone_3"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ readonly "webhook-milestone-deleted": { @@ -51195,7 +51857,7 @@ export type components = { readonly milestone: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ readonly "webhook-milestone-edited": { @@ -51221,7 +51883,7 @@ export type components = { readonly milestone: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ readonly "webhook-milestone-opened": { @@ -51232,7 +51894,7 @@ export type components = { readonly milestone: components["schemas"]["webhooks_milestone_3"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** org_block blocked event */ readonly "webhook-org-block-blocked": { @@ -51243,7 +51905,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** org_block unblocked event */ readonly "webhook-org-block-unblocked": { @@ -51254,7 +51916,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** organization deleted event */ readonly "webhook-organization-deleted": { @@ -51265,7 +51927,7 @@ export type components = { readonly membership?: components["schemas"]["webhooks_membership"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ readonly "webhook-organization-member-added": { @@ -51276,7 +51938,7 @@ export type components = { readonly membership: components["schemas"]["webhooks_membership"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ readonly "webhook-organization-member-invited": { @@ -51331,6 +51993,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly login: string | null; readonly node_id: string; @@ -51340,7 +52003,7 @@ export type components = { }; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ @@ -51352,7 +52015,7 @@ export type components = { readonly membership: components["schemas"]["webhooks_membership"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ readonly "webhook-organization-renamed": { @@ -51368,7 +52031,7 @@ export type components = { readonly membership?: components["schemas"]["webhooks_membership"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ readonly "webhook-rubygems-metadata": { @@ -51442,6 +52105,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly package_type: string; readonly package_version: { @@ -51481,6 +52145,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly body?: string | Record; readonly body_html?: string; @@ -51609,6 +52274,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly created_at: string; readonly draft: boolean; @@ -51644,7 +52310,7 @@ export type components = { readonly updated_at: string | null; }; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** package updated event */ readonly "webhook-package-updated": { @@ -51699,6 +52365,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly package_type: string; readonly package_version: { @@ -51738,6 +52405,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly body: string; readonly body_html: string; @@ -51809,6 +52477,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly created_at: string; readonly draft: boolean; @@ -51845,7 +52514,7 @@ export type components = { readonly updated_at: string; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** page_build event */ readonly "webhook-page-build": { @@ -51893,6 +52562,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly status: string; readonly updated_at: string; @@ -51904,7 +52574,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** personal_access_token_request approved event */ readonly "webhook-personal-access-token-request-approved": { @@ -51913,7 +52583,7 @@ export type components = { readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request cancelled event */ @@ -51923,7 +52593,7 @@ export type components = { readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request created event */ @@ -51933,7 +52603,7 @@ export type components = { readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly installation?: components["schemas"]["simple-installation"]; }; /** personal_access_token_request denied event */ @@ -51943,7 +52613,7 @@ export type components = { readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly installation: components["schemas"]["simple-installation"]; }; readonly "webhook-ping": { @@ -51990,7 +52660,7 @@ export type components = { readonly hook_id?: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ readonly zen?: string; }; @@ -52013,7 +52683,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_card: components["schemas"]["webhooks_project_card"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project_card created event */ readonly "webhook-project-card-created": { @@ -52024,7 +52694,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_card: components["schemas"]["webhooks_project_card"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ readonly "webhook-project-card-deleted": { @@ -52081,6 +52751,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The project card's ID */ readonly id: number; @@ -52094,7 +52765,7 @@ export type components = { readonly url: string; }; readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ readonly "webhook-project-card-edited": { @@ -52110,7 +52781,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_card: components["schemas"]["webhooks_project_card"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ readonly "webhook-project-card-moved": { @@ -52171,6 +52842,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The project card's ID */ readonly id: number; @@ -52216,7 +52888,7 @@ export type components = { readonly url?: string; }; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project closed event */ readonly "webhook-project-closed": { @@ -52227,7 +52899,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project: components["schemas"]["webhooks_project"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project_column created event */ readonly "webhook-project-column-created": { @@ -52238,7 +52910,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_column: components["schemas"]["webhooks_project_column"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ readonly "webhook-project-column-deleted": { @@ -52249,7 +52921,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_column: components["schemas"]["webhooks_project_column"]; readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ readonly "webhook-project-column-edited": { @@ -52265,7 +52937,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_column: components["schemas"]["webhooks_project_column"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ readonly "webhook-project-column-moved": { @@ -52276,7 +52948,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_column: components["schemas"]["webhooks_project_column"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project created event */ readonly "webhook-project-created": { @@ -52287,7 +52959,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project: components["schemas"]["webhooks_project"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project deleted event */ readonly "webhook-project-deleted": { @@ -52298,7 +52970,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project: components["schemas"]["webhooks_project"]; readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** project edited event */ readonly "webhook-project-edited": { @@ -52320,7 +52992,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project: components["schemas"]["webhooks_project"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ readonly "webhook-project-reopened": { @@ -52331,7 +53003,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project: components["schemas"]["webhooks_project"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ readonly "webhook-projects-v2-project-closed": { @@ -52340,7 +53012,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ readonly "webhook-projects-v2-project-created": { @@ -52349,7 +53021,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ readonly "webhook-projects-v2-project-deleted": { @@ -52358,7 +53030,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ readonly "webhook-projects-v2-project-edited": { @@ -52385,7 +53057,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ readonly "webhook-projects-v2-item-archived": { @@ -52395,7 +53067,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ readonly "webhook-projects-v2-item-converted": { @@ -52410,7 +53082,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ readonly "webhook-projects-v2-item-created": { @@ -52419,7 +53091,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ readonly "webhook-projects-v2-item-deleted": { @@ -52428,7 +53100,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ readonly "webhook-projects-v2-item-edited": { @@ -52454,7 +53126,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ readonly "webhook-projects-v2-item-reordered": { @@ -52469,7 +53141,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ readonly "webhook-projects-v2-item-restored": { @@ -52479,7 +53151,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ readonly "webhook-projects-v2-project-reopened": { @@ -52488,7 +53160,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Created Event */ readonly "webhook-projects-v2-status-update-created": { @@ -52497,7 +53169,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Deleted Event */ readonly "webhook-projects-v2-status-update-deleted": { @@ -52506,7 +53178,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Edited Event */ readonly "webhook-projects-v2-status-update-edited": { @@ -52539,7 +53211,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** public event */ readonly "webhook-public": { @@ -52547,7 +53219,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request assigned event */ readonly "webhook-pull-request-assigned": { @@ -52641,6 +53313,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -52677,6 +53350,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -52729,6 +53403,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -52952,6 +53627,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -53012,7 +53688,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -53061,6 +53737,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -53296,6 +53973,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -53356,7 +54034,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -53405,6 +54083,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -53472,6 +54151,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -53519,6 +54199,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -53585,6 +54266,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -53742,10 +54424,11 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ readonly "webhook-pull-request-auto-merge-disabled": { @@ -53838,6 +54521,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -53926,6 +54610,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -54149,6 +54834,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -54209,7 +54895,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -54258,6 +54944,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -54493,6 +55180,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -54553,7 +55241,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -54602,6 +55290,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -54669,6 +55358,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -54716,6 +55406,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -54782,6 +55473,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -54939,11 +55631,12 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly reason: string; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ readonly "webhook-pull-request-auto-merge-enabled": { @@ -55036,6 +55729,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -55124,6 +55818,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -55347,6 +56042,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -55407,7 +56103,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -55456,6 +56152,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -55688,6 +56385,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -55748,7 +56446,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -55797,6 +56495,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -55864,6 +56563,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -55911,6 +56611,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -55977,6 +56678,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -56134,11 +56836,12 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly reason?: string; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ readonly "webhook-pull-request-closed": { @@ -56150,7 +56853,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["pull-request-webhook"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ readonly "webhook-pull-request-converted-to-draft": { @@ -56162,7 +56865,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["pull-request-webhook"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ readonly "webhook-pull-request-demilestoned": { @@ -56174,7 +56877,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["webhooks_pull_request_5"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** pull_request dequeued event */ readonly "webhook-pull-request-dequeued": { @@ -56267,6 +56970,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -56355,6 +57059,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -56578,6 +57283,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -56638,7 +57344,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -56687,6 +57393,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -56922,6 +57629,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -56982,7 +57690,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -57031,6 +57739,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -57098,6 +57807,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -57145,6 +57855,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -57211,6 +57922,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -57368,11 +58080,13 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; - readonly reason: string; + /** @enum {string} */ + readonly reason: "UNKNOWN_REMOVAL_REASON" | "MANUAL" | "MERGE" | "MERGE_CONFLICT" | "CI_FAILURE" | "CI_TIMEOUT" | "ALREADY_MERGED" | "QUEUE_CLEARED" | "ROLL_BACK" | "BRANCH_PROTECTIONS" | "GIT_TREE_INVALID" | "INVALID_MERGE_COMMIT"; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request edited event */ readonly "webhook-pull-request-edited": { @@ -57403,7 +58117,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["pull-request-webhook"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** pull_request enqueued event */ readonly "webhook-pull-request-enqueued": { @@ -57496,6 +58210,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -57584,6 +58299,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -57807,6 +58523,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -57867,7 +58584,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -57916,6 +58633,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -58151,6 +58869,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -58211,7 +58930,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -58260,6 +58979,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -58327,6 +59047,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -58374,6 +59095,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -58440,6 +59162,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -58597,10 +59320,11 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ readonly "webhook-pull-request-labeled": { @@ -58694,6 +59418,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -58782,6 +59507,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -59005,6 +59731,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -59065,7 +59792,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -59114,6 +59841,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -59349,6 +60077,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -59409,7 +60138,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -59458,6 +60187,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -59525,6 +60255,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -59572,6 +60303,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -59638,6 +60370,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -59795,10 +60528,11 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ readonly "webhook-pull-request-locked": { @@ -59891,6 +60625,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -59979,6 +60714,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -60202,6 +60938,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -60262,7 +60999,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -60311,6 +61048,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -60546,6 +61284,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -60606,7 +61345,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -60655,6 +61394,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -60722,6 +61462,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -60769,6 +61510,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -60835,6 +61577,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -60992,10 +61735,11 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ readonly "webhook-pull-request-milestoned": { @@ -61007,7 +61751,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["webhooks_pull_request_5"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ readonly "webhook-pull-request-opened": { @@ -61019,7 +61763,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["pull-request-webhook"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ readonly "webhook-pull-request-ready-for-review": { @@ -61031,7 +61775,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["pull-request-webhook"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ readonly "webhook-pull-request-reopened": { @@ -61043,7 +61787,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["pull-request-webhook"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ readonly "webhook-pull-request-review-comment-created": { @@ -61193,6 +61937,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -61279,6 +62024,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -61367,6 +62113,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -61590,6 +62337,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -61650,7 +62398,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -61699,6 +62447,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -61927,6 +62676,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -61987,7 +62737,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -62036,6 +62786,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -62107,6 +62858,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -62171,6 +62923,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -62322,10 +63075,11 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ readonly "webhook-pull-request-review-comment-deleted": { @@ -62416,6 +63170,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -62504,6 +63259,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -62727,6 +63483,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -62787,7 +63544,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -62836,6 +63593,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -63064,6 +63822,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -63124,7 +63883,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -63173,6 +63932,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -63244,6 +64004,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -63308,6 +64069,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -63459,10 +64221,11 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ readonly "webhook-pull-request-review-comment-edited": { @@ -63554,6 +64317,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -63590,6 +64354,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -63642,6 +64407,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -63865,6 +64631,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -63925,7 +64692,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -63974,6 +64741,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -64202,6 +64970,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -64262,7 +65031,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -64311,6 +65080,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -64382,6 +65152,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -64446,6 +65217,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -64595,12 +65367,13 @@ export type components = { readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly user_view_type?: string; /** Format: uri */ readonly url?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ readonly "webhook-pull-request-review-dismissed": { @@ -64691,6 +65464,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -64779,6 +65553,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -65002,6 +65777,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -65062,7 +65838,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -65111,6 +65887,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -65339,6 +66116,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -65399,7 +66177,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -65448,6 +66226,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -65519,6 +66298,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -65583,6 +66363,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -65734,6 +66515,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; @@ -65809,9 +66591,10 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ readonly "webhook-pull-request-review-edited": { @@ -65908,6 +66691,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -65996,6 +66780,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -66197,6 +66982,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -66282,6 +67068,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -66488,6 +67275,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -66573,6 +67361,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -66644,6 +67433,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -66708,6 +67498,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -66859,11 +67650,12 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; readonly review: components["schemas"]["webhooks_review"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ readonly "webhook-pull-request-review-request-removed": { @@ -66957,6 +67749,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -66993,6 +67786,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -67045,6 +67839,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -67268,6 +68063,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -67321,7 +68117,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -67370,6 +68166,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -67605,6 +68402,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -67665,7 +68463,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -67714,6 +68512,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -67781,6 +68580,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -67828,6 +68628,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -67894,6 +68695,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -68051,6 +68853,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; @@ -68090,8 +68893,9 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ readonly action: "review_request_removed"; @@ -68183,6 +68987,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -68219,6 +69024,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -68271,6 +69077,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -68494,6 +69301,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -68554,7 +69362,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -68603,6 +69411,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -68838,6 +69647,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -68898,7 +69708,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -68947,6 +69757,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -69014,6 +69825,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -69061,6 +69873,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -69127,6 +69940,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -69284,6 +70098,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; @@ -69342,7 +70157,7 @@ export type components = { */ readonly url: string; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request review_requested event */ readonly "webhook-pull-request-review-requested": { @@ -69436,6 +70251,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -69472,6 +70288,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -69524,6 +70341,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -69747,6 +70565,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -69807,7 +70626,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -69856,6 +70675,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -70091,6 +70911,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -70151,7 +70972,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -70200,6 +71021,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -70267,6 +71089,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -70314,6 +71137,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -70380,6 +71204,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -70537,6 +71362,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; @@ -70576,8 +71402,9 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ readonly action: "review_requested"; @@ -70669,6 +71496,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -70705,6 +71533,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -70757,6 +71586,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -70980,6 +71810,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -71040,7 +71871,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -71089,6 +71920,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -71324,6 +72156,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -71384,7 +72217,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -71433,6 +72266,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -71500,6 +72334,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -71547,6 +72382,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -71613,6 +72449,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -71770,6 +72607,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; @@ -71828,7 +72666,7 @@ export type components = { */ readonly url?: string; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request_review submitted event */ readonly "webhook-pull-request-review-submitted": { @@ -71919,6 +72757,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -72007,6 +72846,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -72230,6 +73070,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -72290,7 +73131,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -72339,6 +73180,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -72567,6 +73409,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -72627,7 +73470,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -72676,6 +73519,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -72747,6 +73591,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -72811,6 +73656,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -72962,11 +73808,12 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; readonly review: components["schemas"]["webhooks_review"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ readonly "webhook-pull-request-review-thread-resolved": { @@ -73057,6 +73904,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -73145,6 +73993,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -73351,6 +74200,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -73438,6 +74288,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -73649,6 +74500,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -73736,6 +74588,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -73807,6 +74660,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -73871,6 +74725,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -74022,10 +74877,11 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; readonly thread: { readonly comments: readonly { readonly _links: { @@ -74167,6 +75023,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }[]; readonly node_id: string; @@ -74261,6 +75118,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -74349,6 +75207,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -74555,6 +75414,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -74642,6 +75502,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -74853,6 +75714,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -74940,6 +75802,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -75011,6 +75874,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -75075,6 +75939,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -75226,10 +76091,11 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; readonly thread: { readonly comments: readonly { readonly _links: { @@ -75371,6 +76237,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }[]; readonly node_id: string; @@ -75469,6 +76336,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -75557,6 +76425,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -75780,6 +76649,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -75840,7 +76710,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -75889,6 +76759,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -76117,6 +76988,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -76177,7 +77049,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -76226,6 +77098,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -76293,6 +77166,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -76340,6 +77214,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -76406,6 +77281,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -76563,10 +77439,11 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ readonly "webhook-pull-request-unassigned": { @@ -76660,6 +77537,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -76748,6 +77626,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -76971,6 +77850,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -77031,7 +77911,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -77080,6 +77960,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -77315,6 +78196,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -77375,7 +78257,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -77424,6 +78306,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -77491,6 +78374,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -77538,6 +78422,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -77604,6 +78489,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -77761,10 +78647,11 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ readonly "webhook-pull-request-unlabeled": { @@ -77858,6 +78745,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -77946,6 +78834,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -78169,6 +79058,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -78229,7 +79119,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -78278,6 +79168,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -78506,6 +79397,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -78566,7 +79458,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -78615,6 +79507,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -78682,6 +79575,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -78729,6 +79623,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -78795,6 +79690,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -78952,10 +79848,11 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ readonly "webhook-pull-request-unlocked": { @@ -79048,6 +79945,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -79136,6 +80034,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -79359,6 +80258,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -79419,7 +80319,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -79468,6 +80368,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -79703,6 +80604,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -79763,7 +80665,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -79812,6 +80714,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -79879,6 +80782,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -79926,6 +80830,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -79992,6 +80897,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -80149,10 +81055,11 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** push event */ readonly "webhook-push": { @@ -80489,6 +81396,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -80538,7 +81446,7 @@ export type components = { /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; readonly "webhook-registry-package-published": { /** @enum {string} */ @@ -80573,6 +81481,7 @@ export type components = { readonly subscriptions_url: string; readonly type: string; readonly url: string; + readonly user_view_type?: string; }; readonly package_type: string; readonly package_version: { @@ -80595,6 +81504,7 @@ export type components = { readonly subscriptions_url: string; readonly type: string; readonly url: string; + readonly user_view_type?: string; }; readonly body?: string | Record; readonly body_html?: string; @@ -80704,6 +81614,7 @@ export type components = { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly created_at?: string; readonly draft?: boolean; @@ -80734,7 +81645,7 @@ export type components = { readonly updated_at: string | null; }; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; readonly "webhook-registry-package-updated": { /** @enum {string} */ @@ -80769,6 +81680,7 @@ export type components = { readonly subscriptions_url: string; readonly type: string; readonly url: string; + readonly user_view_type?: string; }; readonly package_type: string; readonly package_version: { @@ -80791,6 +81703,7 @@ export type components = { readonly subscriptions_url: string; readonly type: string; readonly url: string; + readonly user_view_type?: string; }; readonly body: string; readonly body_html: string; @@ -80843,6 +81756,7 @@ export type components = { readonly subscriptions_url: string; readonly type: string; readonly url: string; + readonly user_view_type?: string; }; readonly created_at: string; readonly draft: boolean; @@ -80867,7 +81781,7 @@ export type components = { readonly updated_at: string; }; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** release created event */ readonly "webhook-release-created": { @@ -80878,7 +81792,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly release: components["schemas"]["webhooks_release"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** release deleted event */ readonly "webhook-release-deleted": { @@ -80889,7 +81803,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly release: components["schemas"]["webhooks_release"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** release edited event */ readonly "webhook-release-edited": { @@ -80914,7 +81828,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly release: components["schemas"]["webhooks_release"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ readonly "webhook-release-prereleased": { @@ -81026,6 +81940,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly body: string | null; /** Format: date-time */ @@ -81074,7 +81989,7 @@ export type components = { readonly zipball_url: string | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** release published event */ readonly "webhook-release-published": { @@ -81085,7 +82000,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly release: components["schemas"]["webhooks_release_1"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** release released event */ readonly "webhook-release-released": { @@ -81096,7 +82011,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly release: components["schemas"]["webhooks_release"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ readonly "webhook-release-unpublished": { @@ -81107,7 +82022,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly release: components["schemas"]["webhooks_release_1"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** Repository advisory published event */ readonly "webhook-repository-advisory-published": { @@ -81118,7 +82033,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly repository_advisory: components["schemas"]["repository-advisory"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** Repository advisory reported event */ readonly "webhook-repository-advisory-reported": { @@ -81129,7 +82044,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly repository_advisory: components["schemas"]["repository-advisory"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ readonly "webhook-repository-archived": { @@ -81139,7 +82054,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository created event */ readonly "webhook-repository-created": { @@ -81149,7 +82064,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository deleted event */ readonly "webhook-repository-deleted": { @@ -81159,7 +82074,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository_dispatch event */ readonly "webhook-repository-dispatch-sample": { @@ -81174,7 +82089,7 @@ export type components = { readonly installation: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository edited event */ readonly "webhook-repository-edited": { @@ -81198,7 +82113,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository_import event */ readonly "webhook-repository-import": { @@ -81206,7 +82121,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; /** @enum {string} */ readonly status: "success" | "cancelled" | "failure"; }; @@ -81218,7 +82133,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository publicized event */ readonly "webhook-repository-publicized": { @@ -81228,7 +82143,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository renamed event */ readonly "webhook-repository-renamed": { @@ -81245,7 +82160,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository ruleset created event */ readonly "webhook-repository-ruleset-created": { @@ -81256,7 +82171,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository ruleset deleted event */ readonly "webhook-repository-ruleset-deleted": { @@ -81267,7 +82182,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository ruleset edited event */ readonly "webhook-repository-ruleset-edited": { @@ -81325,7 +82240,7 @@ export type components = { }[]; }; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ readonly "webhook-repository-transferred": { @@ -81396,6 +82311,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; }; @@ -81404,7 +82320,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository unarchived event */ readonly "webhook-repository-unarchived": { @@ -81414,7 +82330,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert create event */ readonly "webhook-repository-vulnerability-alert-create": { @@ -81425,7 +82341,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert dismiss event */ readonly "webhook-repository-vulnerability-alert-dismiss": { @@ -81478,6 +82394,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly external_identifier: string; /** Format: uri */ @@ -81498,7 +82415,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert reopen event */ readonly "webhook-repository-vulnerability-alert-reopen": { @@ -81509,7 +82426,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert resolve event */ readonly "webhook-repository-vulnerability-alert-resolve": { @@ -81581,7 +82498,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** secret_scanning_alert created event */ readonly "webhook-secret-scanning-alert-created": { @@ -81592,7 +82509,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ readonly "webhook-secret-scanning-alert-location-created": { @@ -81603,13 +82520,24 @@ export type components = { readonly location: components["schemas"]["secret-scanning-location"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ readonly "webhook-secret-scanning-alert-location-created-form-encoded": { /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ readonly payload: string; }; + /** secret_scanning_alert publicly leaked event */ + readonly "webhook-secret-scanning-alert-publicly-leaked": { + /** @enum {string} */ + readonly action: "publicly_leaked"; + readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; + }; /** secret_scanning_alert reopened event */ readonly "webhook-secret-scanning-alert-reopened": { /** @enum {string} */ @@ -81619,7 +82547,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert resolved event */ readonly "webhook-secret-scanning-alert-resolved": { @@ -81630,7 +82558,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert validated event */ readonly "webhook-secret-scanning-alert-validated": { @@ -81641,7 +82569,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ readonly "webhook-security-advisory-published": { @@ -81652,7 +82580,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly security_advisory: components["schemas"]["webhooks_security_advisory"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ readonly "webhook-security-advisory-updated": { @@ -81663,7 +82591,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly security_advisory: components["schemas"]["webhooks_security_advisory"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ readonly "webhook-security-advisory-withdrawn": { @@ -81711,7 +82639,7 @@ export type components = { }[]; readonly withdrawn_at: string; }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ readonly "webhook-security-and-analysis": { @@ -81724,7 +82652,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["full-repository"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ readonly "webhook-sponsorship-cancelled": { @@ -81734,7 +82662,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ @@ -81745,7 +82673,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ @@ -81762,7 +82690,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ @@ -81774,7 +82702,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ @@ -81787,7 +82715,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ @@ -81799,7 +82727,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ @@ -81810,7 +82738,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ readonly starred_at: string | null; }; @@ -81822,7 +82750,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ readonly starred_at: unknown; }; @@ -81986,7 +82914,7 @@ export type components = { readonly name: string; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ readonly sha: string; /** @@ -82012,7 +82940,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** parent issue removed event */ readonly "webhook-sub-issues-parent-issue-removed": { @@ -82028,7 +82956,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** sub-issue added event */ readonly "webhook-sub-issues-sub-issue-added": { @@ -82044,7 +82972,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** sub-issue removed event */ readonly "webhook-sub-issues-sub-issue-removed": { @@ -82060,7 +82988,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** team_add event */ readonly "webhook-team-add": { @@ -82068,7 +82996,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ @@ -82273,6 +83201,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -82320,7 +83249,7 @@ export type components = { readonly watchers: number; readonly watchers_count: number; }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; readonly team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ @@ -82525,6 +83454,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -82572,7 +83502,7 @@ export type components = { readonly watchers: number; readonly watchers_count: number; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ @@ -82777,6 +83707,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -82824,7 +83755,7 @@ export type components = { readonly watchers: number; readonly watchers_count: number; }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; readonly team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ @@ -83060,6 +83991,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -83107,7 +84039,7 @@ export type components = { readonly watchers: number; readonly watchers_count: number; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ @@ -83312,6 +84244,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -83359,7 +84292,7 @@ export type components = { readonly watchers: number; readonly watchers_count: number; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ @@ -83370,7 +84303,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** workflow_dispatch event */ readonly "webhook-workflow-dispatch": { @@ -83382,7 +84315,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly ref: string; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow: string; }; /** workflow_job completed event */ @@ -83393,7 +84326,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { /** Format: uri */ readonly check_run_url: string; @@ -83483,7 +84416,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { /** Format: uri */ readonly check_run_url: string; @@ -83581,7 +84514,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { /** Format: uri */ readonly check_run_url: string; @@ -83635,7 +84568,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { /** Format: uri */ readonly check_run_url: string; @@ -83689,7 +84622,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ readonly workflow_run: { @@ -83729,6 +84662,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: uri */ readonly artifacts_url: string; @@ -83879,6 +84813,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; @@ -84051,6 +84986,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; @@ -84119,6 +85055,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: date-time */ readonly updated_at: string; @@ -84142,7 +85079,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ readonly workflow_run: { @@ -84590,7 +85527,7 @@ export type components = { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ readonly workflow_run: { @@ -84630,6 +85567,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: uri */ readonly artifacts_url: string; @@ -84780,6 +85718,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; @@ -84952,6 +85891,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; @@ -85020,6 +85960,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: date-time */ readonly updated_at: string; @@ -85113,6 +86054,15 @@ export type components = { readonly "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + readonly usage_metrics_api_disabled: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Service unavailable */ readonly service_unavailable: { headers: { @@ -85361,6 +86311,12 @@ export type components = { readonly "secret-scanning-alert-sort": "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ readonly "secret-scanning-alert-validity": string; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + readonly "secret-scanning-alert-publicly-leaked": boolean; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + readonly "secret-scanning-alert-multi-repo": boolean; + /** @description The slug of the enterprise team name. */ + readonly "enterprise-team-slug": string; /** @description The slug of the team name. */ readonly "team-slug": string; /** @description The unique identifier of the gist. */ @@ -85393,6 +86349,10 @@ export type components = { readonly org: string; /** @description The unique identifier of the repository. */ readonly "repository-id": number; + /** @description Only return runner groups that are allowed to be used by this repository. */ + readonly "visible-to-repository": string; + /** @description Unique identifier of the self-hosted runner group. */ + readonly "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ readonly "runner-id": number; /** @description The name of a self-hosted runner's custom label. */ @@ -85413,6 +86373,22 @@ export type components = { readonly "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ readonly "hook-id": number; + /** @description The type of the actor */ + readonly "api-insights-actor-type": "installations" | "classic_pats" | "fine_grained_pats" | "oauth_apps" | "github_apps_user_to_server"; + /** @description The ID of the actor */ + readonly "api-insights-actor-id": number; + /** @description The minimum timestamp to query for stats */ + readonly "api-insights-min-timestamp": string; + /** @description The maximum timestamp to query for stats */ + readonly "api-insights-max-timestamp": string; + /** @description The property to sort the results by. */ + readonly "api-insights-route-stats-sort": readonly ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[]; + /** @description The property to sort the results by. */ + readonly "api-insights-sort": readonly ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[]; + /** @description The ID of the user to query for stats */ + readonly "api-insights-user-id": string; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + readonly "api-insights-timestamp-increment": string; /** @description The unique identifier of the invitation. */ readonly "invitation-id": number; /** @description The name of the codespace. */ @@ -85448,8 +86424,13 @@ export type components = { readonly "personal-access-token-after": string; /** @description The unique identifier of the fine-grained personal access token. */ readonly "fine-grained-personal-access-token-id": number; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ readonly "custom-property-name": string; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + readonly "ruleset-targets": string; /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ readonly "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ @@ -85542,6 +86523,8 @@ export type components = { readonly status: "queued" | "in_progress" | "completed"; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ readonly "git-ref": components["schemas"]["code-scanning-ref"]; + /** @description The number of the pull request for the results you want to list. */ + readonly "pr-alias": number; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ readonly "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -85865,7 +86848,6 @@ export interface operations { readonly per_page?: components["parameters"]["per-page"]; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ readonly cursor?: components["parameters"]["cursor"]; - readonly redelivery?: boolean; }; readonly header?: never; readonly path?: never; @@ -86340,7 +87322,7 @@ export interface operations { readonly 404: components["responses"]["not_found"]; }; }; - readonly "classroom/list-accepted-assigments-for-an-assignment": { + readonly "classroom/list-accepted-assignments-for-an-assignment": { readonly parameters: { readonly query?: { /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -86574,6 +87556,42 @@ export interface operations { readonly 500: components["responses"]["internal_error"]; }; }; + readonly "copilot/copilot-metrics-for-enterprise": { + readonly parameters: { + readonly query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + readonly since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + readonly until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: number; + }; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["usage_metrics_api_disabled"]; + readonly 500: components["responses"]["internal_error"]; + }; + }; readonly "copilot/usage-metrics-for-enterprise": { readonly parameters: { readonly query?: { @@ -86697,6 +87715,10 @@ export interface operations { readonly after?: components["parameters"]["pagination-after"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ readonly validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + readonly is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + readonly is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; readonly header?: never; readonly path: { @@ -86721,6 +87743,44 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "copilot/copilot-metrics-for-enterprise-team": { + readonly parameters: { + readonly query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + readonly since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + readonly until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: number; + }; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the enterprise team name. */ + readonly team_slug: components["parameters"]["enterprise-team-slug"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["usage_metrics_api_disabled"]; + readonly 500: components["responses"]["internal_error"]; + }; + }; readonly "copilot/usage-metrics-for-enterprise-team": { readonly parameters: { readonly query?: { @@ -88302,7 +89362,7 @@ export interface operations { readonly members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ readonly members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -88335,7 +89395,7 @@ export interface operations { readonly blog?: string; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88346,7 +89406,7 @@ export interface operations { readonly advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * @@ -88357,7 +89417,7 @@ export interface operations { readonly dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * @@ -88368,7 +89428,7 @@ export interface operations { readonly dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88379,7 +89439,7 @@ export interface operations { readonly dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88390,7 +89450,7 @@ export interface operations { readonly secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88403,6 +89463,8 @@ export interface operations { readonly secret_scanning_push_protection_custom_link_enabled?: boolean; /** @description If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. */ readonly secret_scanning_push_protection_custom_link?: string; + /** @description Controls whether or not deploy keys may be added and used for repositories in the organization. */ + readonly deploy_keys_enabled_for_repositories?: boolean; }; }; }; @@ -88788,6 +89850,415 @@ export interface operations { }; }; }; + readonly "actions/list-self-hosted-runner-groups-for-org": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description Only return runner groups that are allowed to be used by this repository. */ + readonly visible_to_repository?: components["parameters"]["visible-to-repository"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly runner_groups: readonly components["schemas"]["runner-groups-org"][]; + }; + }; + }; + }; + }; + readonly "actions/create-self-hosted-runner-group-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Name of the runner group. */ + readonly name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. + * @default all + * @enum {string} + */ + readonly visibility?: "selected" | "all" | "private"; + /** @description List of repository IDs that can access the runner group. */ + readonly selected_repository_ids?: readonly number[]; + /** @description List of runner IDs to add to the runner group. */ + readonly runners?: readonly number[]; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + readonly allows_public_repositories?: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + readonly restricted_to_workflows?: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + readonly selected_workflows?: readonly string[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + readonly "actions/get-self-hosted-runner-group-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + readonly "actions/delete-self-hosted-runner-group-from-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/update-self-hosted-runner-group-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Name of the runner group. */ + readonly name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. + * @enum {string} + */ + readonly visibility?: "selected" | "all" | "private"; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + readonly allows_public_repositories?: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + readonly restricted_to_workflows?: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + readonly selected_workflows?: readonly string[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + readonly "actions/list-repo-access-to-self-hosted-runner-group-in-org": { + readonly parameters: { + readonly query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly repositories: readonly components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + }; + readonly "actions/set-repo-access-to-self-hosted-runner-group-in-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description List of repository IDs that can access the runner group. */ + readonly selected_repository_ids: readonly number[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/add-repo-access-to-self-hosted-runner-group-in-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ + readonly repository_id: components["parameters"]["repository-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ + readonly repository_id: components["parameters"]["repository-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/list-self-hosted-runners-in-group-for-org": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly runners: readonly components["schemas"]["runner"][]; + }; + }; + }; + }; + }; + readonly "actions/set-self-hosted-runners-in-group-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description List of runner IDs to add to the runner group. */ + readonly runners: readonly number[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/add-self-hosted-runner-to-group-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ + readonly runner_id: components["parameters"]["runner-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/remove-self-hosted-runner-from-group-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ + readonly runner_id: components["parameters"]["runner-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; readonly "actions/list-self-hosted-runners-for-org": { readonly parameters: { readonly query?: { @@ -89962,6 +91433,25 @@ export interface operations { * @enum {string} */ readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @default disabled + * @enum {string} + */ + readonly secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + readonly secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + readonly reviewers?: readonly { + /** @description The ID of the team or role selected as a bypass reviewer */ + readonly reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + readonly reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @default disabled @@ -90166,6 +91656,24 @@ export interface operations { * @enum {string} */ readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + readonly secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + readonly secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + readonly reviewers?: readonly { + /** @description The ID of the team or role selected as a bypass reviewer */ + readonly reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + readonly reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @enum {string} @@ -90227,7 +91735,7 @@ export interface operations { * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` * @enum {string} */ - readonly scope: "all" | "public" | "private_or_internal" | "selected"; + readonly scope: "all" | "all_without_configurations" | "public" | "private_or_internal" | "selected"; /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ readonly selected_repository_ids?: readonly number[]; }; @@ -91013,6 +92521,42 @@ export interface operations { readonly 500: components["responses"]["internal_error"]; }; }; + readonly "copilot/copilot-metrics-for-organization": { + readonly parameters: { + readonly query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + readonly since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + readonly until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: number; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["usage_metrics_api_disabled"]; + readonly 500: components["responses"]["internal_error"]; + }; + }; readonly "copilot/usage-metrics-for-org": { readonly parameters: { readonly query?: { @@ -91610,45 +93154,286 @@ export interface operations { readonly 404: components["responses"]["not_found"]; }; }; - readonly "orgs/update-webhook": { + readonly "orgs/update-webhook": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + readonly hook_id: components["parameters"]["hook-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: { + readonly content: { + readonly "application/json": { + /** @description Key/value pairs to provide settings for this webhook. */ + readonly config?: { + readonly url: components["schemas"]["webhook-config-url"]; + readonly content_type?: components["schemas"]["webhook-config-content-type"]; + readonly secret?: components["schemas"]["webhook-config-secret"]; + readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + /** + * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. + * @default [ + * "push" + * ] + */ + readonly events?: readonly string[]; + /** + * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + * @default true + */ + readonly active?: boolean; + /** @example "web" */ + readonly name?: string; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-hook"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/get-webhook-config-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + readonly hook_id: components["parameters"]["hook-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + }; + readonly "orgs/update-webhook-config-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + readonly hook_id: components["parameters"]["hook-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: { + readonly content: { + readonly "application/json": { + readonly url?: components["schemas"]["webhook-config-url"]; + readonly content_type?: components["schemas"]["webhook-config-content-type"]; + readonly secret?: components["schemas"]["webhook-config-secret"]; + readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + }; + readonly "orgs/list-webhook-deliveries": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ + readonly cursor?: components["parameters"]["cursor"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + readonly hook_id: components["parameters"]["hook-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["hook-delivery-item"][]; + }; + }; + readonly 400: components["responses"]["bad_request"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/get-webhook-delivery": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + readonly hook_id: components["parameters"]["hook-id"]; + readonly delivery_id: components["parameters"]["delivery-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["hook-delivery"]; + }; + }; + readonly 400: components["responses"]["bad_request"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/redeliver-webhook-delivery": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + readonly hook_id: components["parameters"]["hook-id"]; + readonly delivery_id: components["parameters"]["delivery-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + readonly 202: components["responses"]["accepted"]; + readonly 400: components["responses"]["bad_request"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/ping-webhook": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + readonly hook_id: components["parameters"]["hook-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "api-insights/get-route-stats-by-actor": { readonly parameters: { - readonly query?: never; + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + readonly direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + readonly sort?: components["parameters"]["api-insights-route-stats-sort"]; + }; readonly header?: never; readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - readonly hook_id: components["parameters"]["hook-id"]; + /** @description The type of the actor */ + readonly actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + readonly actor_id: components["parameters"]["api-insights-actor-id"]; }; readonly cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description Key/value pairs to provide settings for this webhook. */ - readonly config?: { - readonly url: components["schemas"]["webhook-config-url"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - /** - * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. - * @default [ - * "push" - * ] - */ - readonly events?: readonly string[]; - /** - * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - * @default true - */ - readonly active?: boolean; - /** @example "web" */ - readonly name?: string; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["api-insights-route-stats"]; }; }; }; + }; + readonly "api-insights/get-subject-stats": { + readonly parameters: { + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + readonly direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + readonly sort?: components["parameters"]["api-insights-sort"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; readonly responses: { /** @description Response */ readonly 200: { @@ -91656,22 +93441,23 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-hook"]; + readonly "application/json": components["schemas"]["api-insights-subject-stats"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/get-webhook-config-for-org": { + readonly "api-insights/get-summary-stats": { readonly parameters: { - readonly query?: never; + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; readonly header?: never; readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - readonly hook_id: components["parameters"]["hook-id"]; }; readonly cookie?: never; }; @@ -91683,33 +93469,61 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + readonly "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - readonly "orgs/update-webhook-config-for-org": { + readonly "api-insights/get-summary-stats-by-user": { readonly parameters: { - readonly query?: never; + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; readonly header?: never; readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - readonly hook_id: components["parameters"]["hook-id"]; + /** @description The ID of the user to query for stats */ + readonly user_id: components["parameters"]["api-insights-user-id"]; }; readonly cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - readonly url?: components["schemas"]["webhook-config-url"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; + }; + readonly "api-insights/get-summary-stats-by-actor": { + readonly parameters: { + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The type of the actor */ + readonly actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + readonly actor_id: components["parameters"]["api-insights-actor-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; readonly responses: { /** @description Response */ readonly 200: { @@ -91717,26 +93531,25 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + readonly "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - readonly "orgs/list-webhook-deliveries": { + readonly "api-insights/get-time-stats": { readonly parameters: { - readonly query?: { - /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: components["parameters"]["per-page"]; - /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - readonly cursor?: components["parameters"]["cursor"]; - readonly redelivery?: boolean; + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + readonly timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; readonly header?: never; readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - readonly hook_id: components["parameters"]["hook-id"]; }; readonly cookie?: never; }; @@ -91748,23 +93561,27 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["hook-delivery-item"][]; + readonly "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/get-webhook-delivery": { + readonly "api-insights/get-time-stats-by-user": { readonly parameters: { - readonly query?: never; + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + readonly timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; readonly header?: never; readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - readonly hook_id: components["parameters"]["hook-id"]; - readonly delivery_id: components["parameters"]["delivery-id"]; + /** @description The ID of the user to query for stats */ + readonly user_id: components["parameters"]["api-insights-user-id"]; }; readonly cookie?: never; }; @@ -91776,55 +93593,81 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hook-delivery"]; + readonly "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/redeliver-webhook-delivery": { + readonly "api-insights/get-time-stats-by-actor": { readonly parameters: { - readonly query?: never; + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + readonly timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; readonly header?: never; readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - readonly hook_id: components["parameters"]["hook-id"]; - readonly delivery_id: components["parameters"]["delivery-id"]; + /** @description The type of the actor */ + readonly actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + readonly actor_id: components["parameters"]["api-insights-actor-id"]; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; }; }; - readonly "orgs/ping-webhook": { + readonly "api-insights/get-user-stats": { readonly parameters: { - readonly query?: never; + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + readonly direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + readonly sort?: components["parameters"]["api-insights-sort"]; + }; readonly header?: never; readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - readonly hook_id: components["parameters"]["hook-id"]; + /** @description The ID of the user to query for stats */ + readonly user_id: components["parameters"]["api-insights-user-id"]; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { /** @description Response */ - readonly 204: { + readonly 200: { headers: { readonly [name: string]: unknown; }; - content?: never; + content: { + readonly "application/json": components["schemas"]["api-insights-user-stats"]; + }; }; - readonly 404: components["responses"]["not_found"]; }; }; readonly "apps/get-org-installation": { @@ -93805,7 +95648,7 @@ export interface operations { readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ readonly custom_property_name: components["parameters"]["custom-property-name"]; }; readonly cookie?: never; @@ -93832,7 +95675,7 @@ export interface operations { readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ readonly custom_property_name: components["parameters"]["custom-property-name"]; }; readonly cookie?: never; @@ -93879,7 +95722,7 @@ export interface operations { readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ readonly custom_property_name: components["parameters"]["custom-property-name"]; }; readonly cookie?: never; @@ -94191,7 +96034,7 @@ export interface operations { readonly delete_branch_on_merge?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default?: boolean; @@ -94263,6 +96106,11 @@ export interface operations { readonly per_page?: components["parameters"]["per-page"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ readonly page?: components["parameters"]["page"]; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + readonly targets?: components["parameters"]["ruleset-targets"]; }; readonly header?: never; readonly path: { @@ -94526,6 +96374,10 @@ export interface operations { readonly after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ readonly validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + readonly is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + readonly is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; readonly header?: never; readonly path: { @@ -94726,6 +96578,44 @@ export interface operations { }; }; }; + readonly "copilot/copilot-metrics-for-team": { + readonly parameters: { + readonly query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + readonly since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + readonly until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: number; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + readonly team_slug: components["parameters"]["team-slug"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["usage_metrics_api_disabled"]; + readonly 500: components["responses"]["internal_error"]; + }; + }; readonly "copilot/usage-metrics-for-team": { readonly parameters: { readonly query?: { @@ -94836,7 +96726,7 @@ export interface operations { */ readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -94946,7 +96836,7 @@ export interface operations { */ readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -96957,6 +98847,11 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ readonly status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." */ + readonly secret_scanning_ai_detection?: { + /** @description Can be `enabled` or `disabled`. */ + readonly status?: string; + }; /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ readonly secret_scanning_non_provider_patterns?: { /** @description Can be `enabled` or `disabled`. */ @@ -97017,7 +98912,7 @@ export interface operations { readonly allow_update_branch?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default?: boolean; @@ -99799,7 +101694,7 @@ export interface operations { readonly strict: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ readonly contexts: readonly string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -100268,7 +102163,7 @@ export interface operations { readonly strict?: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ readonly contexts?: readonly string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -100527,12 +102422,12 @@ export interface operations { }; readonly cookie?: never; }; - readonly requestBody?: { + readonly requestBody: { readonly content: { readonly "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ readonly apps: readonly string[]; - } | readonly string[]; + }; }; }; readonly responses: { @@ -100562,12 +102457,12 @@ export interface operations { }; readonly cookie?: never; }; - readonly requestBody?: { + readonly requestBody: { readonly content: { readonly "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ readonly apps: readonly string[]; - } | readonly string[]; + }; }; }; readonly responses: { @@ -100597,12 +102492,12 @@ export interface operations { }; readonly cookie?: never; }; - readonly requestBody?: { + readonly requestBody: { readonly content: { readonly "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ readonly apps: readonly string[]; - } | readonly string[]; + }; }; }; readonly responses: { @@ -100793,12 +102688,12 @@ export interface operations { }; readonly cookie?: never; }; - readonly requestBody?: { + readonly requestBody: { readonly content: { readonly "application/json": { /** @description The username for users */ readonly users: readonly string[]; - } | readonly string[]; + }; }; }; readonly responses: { @@ -100828,12 +102723,12 @@ export interface operations { }; readonly cookie?: never; }; - readonly requestBody?: { + readonly requestBody: { readonly content: { readonly "application/json": { /** @description The username for users */ readonly users: readonly string[]; - } | readonly string[]; + }; }; }; readonly responses: { @@ -100863,12 +102758,12 @@ export interface operations { }; readonly cookie?: never; }; - readonly requestBody?: { + readonly requestBody: { readonly content: { readonly "application/json": { /** @description The username for users */ readonly users: readonly string[]; - } | readonly string[]; + }; }; }; readonly responses: { @@ -101458,8 +103353,14 @@ export interface operations { readonly per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ readonly ref?: components["parameters"]["git-ref"]; + /** @description The number of the pull request for the results you want to list. */ + readonly pr?: components["parameters"]["pr-alias"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; /** @description The property by which to sort the results. */ readonly sort?: "created" | "updated"; /** @description If specified, only code scanning alerts with this state will be returned. */ @@ -101571,6 +103472,8 @@ export interface operations { readonly per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ readonly ref?: components["parameters"]["git-ref"]; + /** @description The number of the pull request for the results you want to list. */ + readonly pr?: components["parameters"]["pr-alias"]; }; readonly header?: never; readonly path: { @@ -101610,6 +103513,8 @@ export interface operations { readonly page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ readonly per_page?: components["parameters"]["per-page"]; + /** @description The number of the pull request for the results you want to list. */ + readonly pr?: components["parameters"]["pr-alias"]; /** @description The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ readonly ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ @@ -101770,6 +103675,34 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "code-scanning/delete-codeql-database": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The language of the CodeQL database. */ + readonly language: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 403: components["responses"]["code_scanning_forbidden_write"]; + readonly 404: components["responses"]["not_found"]; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; readonly "code-scanning/create-variant-analysis": { readonly parameters: { readonly query?: never; @@ -102176,7 +104109,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ readonly location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ readonly geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -103069,7 +105002,7 @@ export interface operations { readonly path?: string; /** @description Line index in the diff to comment on. */ readonly position?: number; - /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ + /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ readonly line?: number; }; }; @@ -103614,7 +105547,7 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** * @deprecated - * @description **Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. + * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. */ readonly page?: number; /** @@ -104325,7 +106258,7 @@ export interface operations { readonly "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ readonly event_type: string; - /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ + /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. */ readonly client_payload?: { readonly [key: string]: unknown; }; @@ -106050,7 +107983,6 @@ export interface operations { readonly per_page?: components["parameters"]["per-page"]; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ readonly cursor?: components["parameters"]["cursor"]; - readonly redelivery?: boolean; }; readonly header?: never; readonly path: { @@ -106740,7 +108672,7 @@ export interface operations { readonly title: string | number; /** @description The contents of the issue. */ readonly body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ + /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ readonly assignee?: string | null; readonly milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ @@ -107125,7 +109057,7 @@ export interface operations { readonly title?: (string | number) | null; /** @description The contents of the issue. */ readonly body?: string | null; - /** @description Username to assign to this issue. **This field is deprecated.** */ + /** @description Username to assign to this issue. **This field is closing down.** */ readonly assignee?: string | null; /** * @description The open or closed state of the issue. @@ -109569,7 +111501,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ readonly location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ readonly geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -109681,7 +111613,7 @@ export interface operations { readonly path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * @description **This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ readonly position?: number; /** @@ -111096,6 +113028,11 @@ export interface operations { readonly page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ readonly includes_parents?: boolean; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + readonly targets?: components["parameters"]["ruleset-targets"]; }; readonly header?: never; readonly path: { @@ -111374,6 +113311,10 @@ export interface operations { readonly after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ readonly validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + readonly is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + readonly is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; readonly header?: never; readonly path: { @@ -112736,12 +114677,12 @@ export interface operations { readonly q: string; /** * @deprecated - * @description **This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) + * @description **This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ readonly sort?: "indexed"; /** * @deprecated - * @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + * @description **This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ readonly order?: "desc" | "asc"; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -113080,7 +115021,7 @@ export interface operations { */ readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -114372,7 +116313,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ readonly location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ readonly geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -114403,7 +116344,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ readonly location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ readonly geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -115232,6 +117173,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; }; }; readonly "users/unfollow": { diff --git a/packages/openapi-typescript/examples/github-api-immutable.ts b/packages/openapi-typescript/examples/github-api-immutable.ts index 116d1bf01..5ac7b0e87 100644 --- a/packages/openapi-typescript/examples/github-api-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-immutable.ts @@ -453,7 +453,7 @@ export interface paths { * List accepted assignments for an assignment * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ - readonly get: operations["classroom/list-accepted-assigments-for-an-assignment"]; + readonly get: operations["classroom/list-accepted-assignments-for-an-assignment"]; readonly put?: never; readonly post?: never; readonly delete?: never; @@ -612,13 +612,16 @@ export interface paths { /** * List all Copilot seat assignments for an enterprise * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + * Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. * * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. * * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + * telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + * see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. * @@ -633,6 +636,35 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/enterprises/{enterprise}/copilot/metrics": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get Copilot metrics for an enterprise + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + readonly get: operations["copilot/copilot-metrics-for-enterprise"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/enterprises/{enterprise}/copilot/usage": { readonly parameters: { readonly query?: never; @@ -643,7 +675,7 @@ export interface paths { /** * Get a summary of Copilot usage for enterprise members * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -653,6 +685,8 @@ export interface paths { * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * + * The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + * * Only owners and billing managers can view Copilot usage metrics for the enterprise. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -718,6 +752,38 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get Copilot metrics for an enterprise team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + readonly get: operations["copilot/copilot-metrics-for-enterprise-team"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { readonly parameters: { readonly query?: never; @@ -728,7 +794,7 @@ export interface paths { /** * Get a summary of Copilot usage for an enterprise team * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -1609,10 +1675,10 @@ export interface paths { /** * Update an organization * @description > [!WARNING] - * > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * > **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * > [!WARNING] - * > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * * Updates the organization's profile and member privileges. * @@ -1842,6 +1908,180 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/actions/runner-groups": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List self-hosted runner groups for an organization + * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["actions/list-self-hosted-runner-groups-for-org"]; + readonly put?: never; + /** + * Create a self-hosted runner group for an organization + * @description Creates a new self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly post: operations["actions/create-self-hosted-runner-group-for-org"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a self-hosted runner group for an organization + * @description Gets a specific self-hosted runner group for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["actions/get-self-hosted-runner-group-for-org"]; + readonly put?: never; + readonly post?: never; + /** + * Delete a self-hosted runner group from an organization + * @description Deletes a self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + readonly options?: never; + readonly head?: never; + /** + * Update a self-hosted runner group for an organization + * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly patch: operations["actions/update-self-hosted-runner-group-for-org"]; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List repository access to a self-hosted runner group in an organization + * @description Lists the repositories with access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; + /** + * Set repository access for a self-hosted runner group in an organization + * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + /** + * Add repository access to a self-hosted runner group in an organization + * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + readonly post?: never; + /** + * Remove repository access to a self-hosted runner group in an organization + * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List self-hosted runners in a group for an organization + * @description Lists self-hosted runners that are in a specific organization group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["actions/list-self-hosted-runners-in-group-for-org"]; + /** + * Set self-hosted runners in a group for an organization + * @description Replaces the list of self-hosted runners that are part of an organization runner group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + /** + * Add a self-hosted runner to a group for an organization + * @description Adds a self-hosted runner to a runner group configured in an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + readonly post?: never; + /** + * Remove a self-hosted runner from a group for an organization + * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/actions/runners": { readonly parameters: { readonly query?: never; @@ -2912,11 +3152,11 @@ export interface paths { /** * Get Copilot seat information and settings for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Gets information about an organization's Copilot subscription, including seat breakdown * and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." * * Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. * @@ -2941,11 +3181,14 @@ export interface paths { /** * List all Copilot seat assignments for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + * Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. * Only organization owners can view assigned seats. * + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ readonly get: operations["copilot/list-copilot-seats"]; @@ -2969,16 +3212,16 @@ export interface paths { /** * Add teams to the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * * Only organization owners can add Copilot seats for their organization members. * * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * * The response will contain the total number of new seats that were created and existing seats that were refreshed. * @@ -2988,17 +3231,19 @@ export interface paths { /** * Remove teams from the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Cancels the Copilot seat assignment for all members of each team specified. - * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Sets seats for all members of each team specified to "pending cancellation". + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * + * The response will contain the total number of seats set to "pending cancellation". + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ readonly delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; @@ -3019,16 +3264,16 @@ export interface paths { /** * Add users to the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * * Only organization owners can add Copilot seats for their organization members. * * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * * The response will contain the total number of new seats that were created and existing seats that were refreshed. * @@ -3038,17 +3283,19 @@ export interface paths { /** * Remove users from the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Cancels the Copilot seat assignment for each user specified. - * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Sets seats for all users specified to "pending cancellation". + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * + * The response will contain the total number of seats set to "pending cancellation". + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ readonly delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; @@ -3057,6 +3304,38 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/copilot/metrics": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get Copilot metrics for an organization + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + * Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + readonly get: operations["copilot/copilot-metrics-for-organization"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/copilot/usage": { readonly parameters: { readonly query?: never; @@ -3067,7 +3346,7 @@ export interface paths { /** * Get a summary of Copilot usage for organization members * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -3534,6 +3813,186 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get route stats by actor + * @description Get API request count statistics for an actor broken down by route within a specified time frame. + */ + readonly get: operations["api-insights/get-route-stats-by-actor"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/subject-stats": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get subject stats + * @description Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + */ + readonly get: operations["api-insights/get-subject-stats"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/summary-stats": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get summary stats + * @description Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + */ + readonly get: operations["api-insights/get-summary-stats"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get summary stats by user + * @description Get overall statistics of API requests within the organization for a user. + */ + readonly get: operations["api-insights/get-summary-stats-by-user"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get summary stats by actor + * @description Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + */ + readonly get: operations["api-insights/get-summary-stats-by-actor"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/time-stats": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get time stats + * @description Get the number of API requests and rate-limited requests made within an organization over a specified time period. + */ + readonly get: operations["api-insights/get-time-stats"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/time-stats/users/{user_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get time stats by user + * @description Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + */ + readonly get: operations["api-insights/get-time-stats-by-user"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get time stats by actor + * @description Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + */ + readonly get: operations["api-insights/get-time-stats-by-actor"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/insights/api/user-stats/{user_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get user stats + * @description Get API usage statistics within an organization for a user broken down by the type of access. + */ + readonly get: operations["api-insights/get-user-stats"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/installation": { readonly parameters: { readonly query?: never; @@ -3831,9 +4290,12 @@ export interface paths { /** * Get Copilot seat assignment details for a user * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + * + * The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * * Only organization owners can view Copilot seat assignment details for members of their organization. * @@ -4272,7 +4734,7 @@ export interface paths { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/list-packages-for-organization"]; readonly put?: never; @@ -4294,7 +4756,7 @@ export interface paths { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-for-organization"]; readonly put?: never; @@ -4305,7 +4767,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-for-org"]; readonly options?: never; @@ -4332,7 +4794,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-for-org"]; readonly delete?: never; @@ -4352,7 +4814,7 @@ export interface paths { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; readonly put?: never; @@ -4374,7 +4836,7 @@ export interface paths { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-version-for-organization"]; readonly put?: never; @@ -4385,7 +4847,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-version-for-org"]; readonly options?: never; @@ -4412,7 +4874,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-version-for-org"]; readonly delete?: never; @@ -5041,6 +5503,38 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/team/{team_slug}/copilot/metrics": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get Copilot metrics for a team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + * Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + readonly get: operations["copilot/copilot-metrics-for-team"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/team/{team_slug}/copilot/usage": { readonly parameters: { readonly query?: never; @@ -5051,7 +5545,7 @@ export interface paths { /** * Get a summary of Copilot usage for a team * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -5689,7 +6183,7 @@ export interface paths { * Enable or disable a security feature for an organization * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). * * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -5949,7 +6443,7 @@ export interface paths { * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." * * > [!NOTE] - * > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ readonly get: operations["rate-limit/get"]; readonly put?: never; @@ -8355,7 +8849,7 @@ export interface paths { * and `0` is returned in this field. * * > [!WARNING] - * > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -8482,7 +8976,7 @@ export interface paths { * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ readonly get: operations["code-scanning/list-codeql-databases"]; readonly put?: never; @@ -8510,12 +9004,18 @@ export interface paths { * your HTTP client is configured to follow redirects or use the `Location` header * to make a second request to get the redirect URL. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ readonly get: operations["code-scanning/get-codeql-database"]; readonly put?: never; readonly post?: never; - readonly delete?: never; + /** + * Delete a CodeQL database + * @description Deletes a CodeQL database for a language in a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + readonly delete: operations["code-scanning/delete-codeql-database"]; readonly options?: never; readonly head?: never; readonly patch?: never; @@ -8894,8 +9394,6 @@ export interface paths { * @description Gets your public key, which you need to encrypt secrets. You need to * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. - * * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["codespaces/get-repo-public-key"]; @@ -11038,7 +11536,7 @@ export interface paths { * @description View the progress of an import. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -11082,7 +11580,7 @@ export interface paths { * return a status `422 Unprocessable Entity` response. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly put: operations["migrations/start-import"]; readonly post?: never; @@ -11092,7 +11590,7 @@ export interface paths { * @description Stop an import for a repository. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly delete: operations["migrations/cancel-import"]; readonly options?: never; @@ -11108,7 +11606,7 @@ export interface paths { * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly patch: operations["migrations/update-import"]; readonly trace?: never; @@ -11128,7 +11626,7 @@ export interface paths { * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly get: operations["migrations/get-commit-authors"]; readonly put?: never; @@ -11159,7 +11657,7 @@ export interface paths { * new commits to the repository. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly patch: operations["migrations/map-commit-author"]; readonly trace?: never; @@ -11177,7 +11675,7 @@ export interface paths { * @description List files larger than 100MB found during the import * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly get: operations["migrations/get-large-files"]; readonly put?: never; @@ -11211,7 +11709,7 @@ export interface paths { * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly patch: operations["migrations/set-lfs-preference"]; readonly trace?: never; @@ -11540,7 +12038,7 @@ export interface paths { readonly head?: never; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12638,7 +13136,7 @@ export interface paths { * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." @@ -12991,6 +13489,7 @@ export interface paths { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ readonly put: operations["pulls/update-branch"]; readonly post?: never; @@ -13885,10 +14384,10 @@ export interface paths { readonly cookie?: never; }; /** - * Deprecated - List tag protection states for a repository + * Closing down - List tag protection states for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. * * This returns the tag protection states of a repository. * @@ -13897,10 +14396,10 @@ export interface paths { readonly get: operations["repos/list-tag-protection"]; readonly put?: never; /** - * Deprecated - Create a tag protection state for a repository + * Closing down - Create a tag protection state for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. * * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13923,10 +14422,10 @@ export interface paths { readonly put?: never; readonly post?: never; /** - * Deprecated - Delete a tag protection state for a repository + * Closing down - Delete a tag protection state for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. * * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -14428,7 +14927,7 @@ export interface paths { * Get a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ readonly get: operations["teams/get-legacy"]; readonly put?: never; @@ -14437,7 +14936,7 @@ export interface paths { * Delete a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -14450,7 +14949,7 @@ export interface paths { * Update a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * @@ -14471,7 +14970,7 @@ export interface paths { * List discussions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -14483,7 +14982,7 @@ export interface paths { * Create a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * @@ -14509,7 +15008,7 @@ export interface paths { * Get a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -14522,7 +15021,7 @@ export interface paths { * Delete a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -14535,7 +15034,7 @@ export interface paths { * Update a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -14555,7 +15054,7 @@ export interface paths { * List discussion comments (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -14567,7 +15066,7 @@ export interface paths { * Create a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * @@ -14593,7 +15092,7 @@ export interface paths { * Get a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -14606,7 +15105,7 @@ export interface paths { * Delete a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -14619,7 +15118,7 @@ export interface paths { * Update a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -14639,7 +15138,7 @@ export interface paths { * List reactions for a team discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14651,7 +15150,7 @@ export interface paths { * Create reaction for a team discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14677,7 +15176,7 @@ export interface paths { * List reactions for a team discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14689,7 +15188,7 @@ export interface paths { * Create reaction for a team discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14715,7 +15214,7 @@ export interface paths { * List pending team invitations (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ @@ -14739,7 +15238,7 @@ export interface paths { * List team members (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -14762,7 +15261,7 @@ export interface paths { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * @@ -14772,7 +15271,7 @@ export interface paths { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * @@ -14790,7 +15289,7 @@ export interface paths { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * @@ -14818,7 +15317,7 @@ export interface paths { * Get team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -14834,7 +15333,7 @@ export interface paths { * Add or update team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -14853,7 +15352,7 @@ export interface paths { * Remove team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -14879,7 +15378,7 @@ export interface paths { * List team projects (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -14903,7 +15402,7 @@ export interface paths { * Check team permissions for a project (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -14912,7 +15411,7 @@ export interface paths { * Add or update team project permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -14922,7 +15421,7 @@ export interface paths { * Remove a project from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -14943,7 +15442,7 @@ export interface paths { * List team repositories (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ readonly get: operations["teams/list-repos-legacy"]; readonly put?: never; @@ -14965,7 +15464,7 @@ export interface paths { * Check team permissions for a repository (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * * > [!NOTE] * > Repositories inherited through a parent team will also be checked. @@ -14977,7 +15476,7 @@ export interface paths { * Add or update team repository permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -14989,7 +15488,7 @@ export interface paths { * Remove a repository from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -15010,7 +15509,7 @@ export interface paths { * List child teams (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ readonly get: operations["teams/list-child-legacy"]; readonly put?: never; @@ -16068,6 +16567,9 @@ export interface paths { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ readonly get: operations["orgs/list-for-authenticated-user"]; readonly put?: never; @@ -16089,7 +16591,7 @@ export interface paths { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/list-packages-for-authenticated-user"]; readonly put?: never; @@ -16111,7 +16613,7 @@ export interface paths { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-for-authenticated-user"]; readonly put?: never; @@ -16120,7 +16622,7 @@ export interface paths { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-for-authenticated-user"]; readonly options?: never; @@ -16145,7 +16647,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-for-authenticated-user"]; readonly delete?: never; @@ -16165,7 +16667,7 @@ export interface paths { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; readonly put?: never; @@ -16187,7 +16689,7 @@ export interface paths { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-version-for-authenticated-user"]; readonly put?: never; @@ -16198,7 +16700,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-version-for-authenticated-user"]; readonly options?: never; @@ -16223,7 +16725,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-version-for-authenticated-user"]; readonly delete?: never; @@ -16652,7 +17154,7 @@ export interface paths { }; /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). * * > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. @@ -16906,7 +17408,7 @@ export interface paths { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/list-packages-for-user"]; readonly put?: never; @@ -16928,7 +17430,7 @@ export interface paths { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-for-user"]; readonly put?: never; @@ -16939,7 +17441,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-for-user"]; readonly options?: never; @@ -16966,7 +17468,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-for-user"]; readonly delete?: never; @@ -16986,7 +17488,7 @@ export interface paths { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; readonly put?: never; @@ -17008,7 +17510,7 @@ export interface paths { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-version-for-user"]; readonly put?: never; @@ -17019,7 +17521,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-version-for-user"]; readonly options?: never; @@ -17046,7 +17548,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-version-for-user"]; readonly delete?: never; @@ -17516,6 +18018,8 @@ export interface components { readonly site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ readonly starred_at?: string; + /** @example public */ + readonly user_view_type?: string; }; /** * @description The type of credit the user is receiving. @@ -17710,6 +18214,8 @@ export interface components { readonly site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ readonly starred_at?: string; + /** @example public */ + readonly user_view_type?: string; } | null; /** * GitHub app @@ -18227,7 +18733,7 @@ export interface components { */ readonly organization_custom_properties?: "read" | "write" | "admin"; /** - * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. * @enum {string} */ readonly organization_copilot_seat_management?: "write"; @@ -18262,7 +18768,7 @@ export interface components { */ readonly organization_plan?: "read"; /** - * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). + * @description The level of permission to grant the access token to manage organization projects and projects public preview (where available). * @enum {string} */ readonly organization_projects?: "read" | "write" | "admin"; @@ -18706,7 +19212,7 @@ export interface components { readonly allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -19290,7 +19796,7 @@ export interface components { * Organization Simple * @description A GitHub organization. */ - readonly "organization-simple": { + readonly "nullable-organization-simple": { /** @example github */ readonly login: string; /** @example 1 */ @@ -19324,7 +19830,7 @@ export interface components { readonly avatar_url: string; /** @example A great organization */ readonly description: string | null; - }; + } | null; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -19433,8 +19939,8 @@ export interface components { readonly url: string; /** @example disabled | all */ readonly sync_to_organizations: string; - /** @example 1 */ - readonly group_id?: number | null; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + readonly group_id?: string | null; /** * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league @@ -19451,12 +19957,8 @@ export interface components { * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ readonly "copilot-seat-details": { - /** @description The assignee that has been granted access to GitHub Copilot. */ - readonly assignee: { - readonly [key: string]: unknown; - } & components["schemas"]["simple-user"]; - /** @description The organization to which this seat belongs. */ - readonly organization?: components["schemas"]["organization-simple"] | null; + readonly assignee: components["schemas"]["simple-user"]; + readonly organization?: components["schemas"]["nullable-organization-simple"]; /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ readonly assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; /** @@ -19481,6 +19983,157 @@ export interface components { * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. */ readonly updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + readonly plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + readonly "copilot-ide-code-completions": ({ + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description Code completion metrics for active languages. */ + readonly languages?: readonly { + /** @description Name of the language used for Copilot code completion suggestions. */ + readonly name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + }[]; + readonly editors?: readonly ({ + /** @description Name of the given editor. */ + readonly name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model. */ + readonly custom_model_training_date?: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description Code completion metrics for active languages, for the given editor. */ + readonly languages?: readonly { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + readonly name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + readonly total_code_suggestions?: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + readonly total_code_acceptances?: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + readonly total_code_lines_suggested?: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + readonly total_code_lines_accepted?: number; + }[]; + }[]; + } & { + readonly [key: string]: unknown; + })[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + readonly "copilot-ide-chat": ({ + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + readonly total_engaged_users?: number; + readonly editors?: readonly { + /** @description Name of the given editor. */ + readonly name?: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model. */ + readonly custom_model_training_date?: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + readonly total_engaged_users?: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + readonly total_chats?: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + readonly total_chat_insertion_events?: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + readonly total_chat_copy_events?: number; + }[]; + }[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in github.com */ + readonly "copilot-dotcom-chat": ({ + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for a custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model (if applicable). */ + readonly custom_model_training_date?: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + readonly total_engaged_users?: number; + /** @description Total number of chats initiated by users on github.com. */ + readonly total_chats?: number; + }[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot for pull requests. */ + readonly "copilot-dotcom-pull-requests": ({ + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + readonly total_engaged_users?: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + readonly repositories?: readonly { + /** @description Repository name */ + readonly name?: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model. */ + readonly custom_model_training_date?: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + readonly total_pr_summaries_created?: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + readonly total_engaged_users?: number; + }[]; + }[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + readonly "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + readonly date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + readonly total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + readonly total_engaged_users?: number; + readonly copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + readonly copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + readonly copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + readonly copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + } & { + readonly [key: string]: unknown; }; /** * Copilot Usage Metrics @@ -19991,6 +20644,10 @@ export interface components { * @enum {string} */ readonly validity?: "active" | "inactive" | "unknown"; + /** @description Whether the secret was publicly leaked. */ + readonly publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + readonly multi_repo?: boolean | null; }; /** * Actor @@ -20438,6 +21095,11 @@ export interface components { readonly language?: string; readonly raw_url?: string; readonly size?: number; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + readonly encoding: string; }; }; readonly public: boolean; @@ -20463,6 +21125,11 @@ export interface components { readonly login: string; /** Format: int64 */ readonly id: number; + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + readonly user_view_type: "public"; readonly node_id: string; /** Format: uri */ readonly avatar_url: string; @@ -20512,8 +21179,6 @@ export interface components { readonly space: number; readonly private_repos: number; }; - /** Format: date-time */ - readonly suspended_at?: string | null; /** @example 1 */ readonly private_gists?: number; /** @example 2 */ @@ -20620,6 +21285,11 @@ export interface components { readonly size?: number; readonly truncated?: boolean; readonly content?: string; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + readonly encoding: string; } | null; }; readonly public?: boolean; @@ -20988,6 +21658,10 @@ export interface components { /** @enum {string} */ readonly status?: "enabled" | "disabled"; }; + readonly secret_scanning_ai_detection?: { + /** @enum {string} */ + readonly status?: "enabled" | "disabled"; + }; } | null; /** * Minimal Repository @@ -21254,6 +21928,45 @@ export interface components { */ readonly repository_url?: string; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + readonly "organization-simple": { + /** @example github */ + readonly login: string; + /** @example 1 */ + readonly id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + readonly node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + readonly url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + readonly repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + readonly events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + readonly hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + readonly issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + readonly members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + readonly public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + readonly avatar_url: string; + /** @example A great organization */ + readonly description: string | null; + }; /** * Organization Full * @description Organization Full @@ -21339,7 +22052,12 @@ export interface components { readonly private_gists?: number | null; /** @example 10000 */ readonly disk_usage?: number | null; - /** @example 8 */ + /** + * @description The number of collaborators on private repositories. + * + * This field may be null if the number of private repositories is over 50,000. + * @example 8 + */ readonly collaborators?: number | null; /** * Format: email @@ -21378,7 +22096,7 @@ export interface components { readonly web_commit_signoff_required?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * @@ -21388,7 +22106,7 @@ export interface components { readonly advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * @@ -21398,7 +22116,7 @@ export interface components { readonly dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * @@ -21408,7 +22126,7 @@ export interface components { readonly dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * @@ -21418,7 +22136,7 @@ export interface components { readonly dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * @@ -21428,7 +22146,7 @@ export interface components { readonly secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * @@ -21455,6 +22173,11 @@ export interface components { readonly updated_at: string; /** Format: date-time */ readonly archived_at: string | null; + /** + * @description Controls whether or not deploy keys may be added and used for repositories in the organization. + * @example false + */ + readonly deploy_keys_enabled_for_repositories?: boolean; }; readonly "actions-cache-usage-org-enterprise": { /** @description The count of active caches across all repositories of an enterprise or an organization. */ @@ -21541,6 +22264,31 @@ export interface components { readonly default_workflow_permissions?: components["schemas"]["actions-default-workflow-permissions"]; readonly can_approve_pull_request_reviews?: components["schemas"]["actions-can-approve-pull-request-reviews"]; }; + readonly "runner-groups-org": { + readonly id: number; + readonly name: string; + readonly visibility: string; + readonly default: boolean; + /** @description Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ + readonly selected_repositories_url?: string; + readonly runners_url: string; + readonly hosted_runners_url?: string; + readonly inherited: boolean; + readonly inherited_allows_public_repositories?: boolean; + readonly allows_public_repositories: boolean; + /** + * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. + * @default false + */ + readonly workflow_restrictions_read_only: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + readonly restricted_to_workflows: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + readonly selected_workflows?: readonly string[]; + }; /** * Self hosted runner label * @description A label for a self hosted runner @@ -21741,9 +22489,9 @@ export interface components { readonly "alert-instances-url": string; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - readonly "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + readonly "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} @@ -21850,7 +22598,7 @@ export interface components { * @description The type of the code security configuration. * @enum {string} */ - readonly target_type?: "global" | "organization"; + readonly target_type?: "global" | "organization" | "enterprise"; /** @description A description of the code security configuration */ readonly description?: string; /** @@ -21898,6 +22646,24 @@ export interface components { * @enum {string} */ readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + readonly secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + readonly secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + readonly reviewers?: readonly { + /** @description The ID of the team or role selected as a bypass reviewer */ + readonly reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + readonly reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @enum {string} @@ -22225,8 +22991,8 @@ export interface components { readonly inactive_this_cycle?: number; }; /** - * Copilot Business Organization Details - * @description Information about the seat breakdown and policies set for an organization with a Copilot Business subscription. + * Copilot Organization Details + * @description Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription. */ readonly "copilot-organization-details": { readonly seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; @@ -22255,6 +23021,11 @@ export interface components { * @enum {string} */ readonly seat_management_setting: "assign_all" | "assign_selected" | "disabled" | "unconfigured"; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + readonly plan_type?: "business" | "enterprise" | "unknown"; } & { readonly [key: string]: unknown; }; @@ -22629,6 +23400,87 @@ export interface components { readonly created_at: string; readonly type: string; }; + /** + * Route Stats + * @description API Insights usage route stats for an actor + */ + readonly "api-insights-route-stats": readonly { + /** @description The HTTP method */ + readonly http_method?: string; + /** @description The API path's route template */ + readonly api_route?: string; + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + readonly total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + readonly rate_limited_request_count?: number; + readonly last_rate_limited_timestamp?: string | null; + readonly last_request_timestamp?: string; + }[]; + /** + * Subject Stats + * @description API Insights usage subject stats for an organization + */ + readonly "api-insights-subject-stats": readonly { + readonly subject_type?: string; + readonly subject_name?: string; + /** Format: int64 */ + readonly subject_id?: number; + readonly total_request_count?: number; + readonly rate_limited_request_count?: number; + readonly last_rate_limited_timestamp?: string | null; + readonly last_request_timestamp?: string; + }[]; + /** + * Summary Stats + * @description API Insights usage summary stats for an organization + */ + readonly "api-insights-summary-stats": { + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + readonly total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + readonly rate_limited_request_count?: number; + }; + /** + * Time Stats + * @description API Insights usage time stats for an organization + */ + readonly "api-insights-time-stats": readonly { + readonly timestamp?: string; + /** Format: int64 */ + readonly total_request_count?: number; + /** Format: int64 */ + readonly rate_limited_request_count?: number; + }[]; + /** + * User Stats + * @description API Insights usage stats for a user + */ + readonly "api-insights-user-stats": readonly { + readonly actor_type?: string; + readonly actor_name?: string; + /** Format: int64 */ + readonly actor_id?: number; + /** Format: int64 */ + readonly integration_id?: number | null; + /** Format: int64 */ + readonly oauth_application_id?: number | null; + readonly total_request_count?: number; + readonly rate_limited_request_count?: number; + readonly last_rate_limited_timestamp?: string | null; + readonly last_request_timestamp?: string; + }[]; /** * @description The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. * @example collaborators_only @@ -22933,6 +23785,8 @@ export interface components { readonly site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ readonly starred_at?: string; + /** @example public */ + readonly user_view_type?: string; }; /** * Package Version @@ -23021,6 +23875,10 @@ export interface components { }; /** @description Date and time when the request for access was created. */ readonly created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + readonly token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + readonly token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ readonly token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -23033,7 +23891,7 @@ export interface components { * @description Minimal representation of an organization programmatic access grant for enumerations */ readonly "organization-programmatic-access-grant": { - /** @description Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token. */ + /** @description Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. */ readonly id: number; readonly owner: components["schemas"]["simple-user"]; /** @@ -23057,6 +23915,10 @@ export interface components { }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ readonly access_granted_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + readonly token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + readonly token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ readonly token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -23485,7 +24347,7 @@ export interface components { readonly allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -23893,7 +24755,8 @@ export interface components { */ readonly actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. + * @default always * @enum {string} */ readonly bypass_mode: "always" | "pull_request"; @@ -23963,7 +24826,9 @@ export interface components { }; /** * Organization ruleset conditions - * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. + * @description Conditions for an organization ruleset. + * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + * The push rulesets conditions object does not require the `ref_name` property. */ readonly "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24052,6 +24917,18 @@ export interface components { /** @enum {string} */ readonly type: "required_signatures"; }; + /** + * RequiredReviewerConfiguration + * @description A reviewing team, and file patterns describing which files they must approve changes to. + */ + readonly "repository-rule-params-required-reviewer-configuration": { + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files. */ + readonly file_patterns: readonly string[]; + /** @description Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. */ + readonly minimum_approvals: number; + /** @description Node ID of the team which must review changes to matching files. */ + readonly reviewer_id: string; + }; /** * pull_request * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -24351,7 +25228,7 @@ export interface components { readonly html?: { /** @description The html URL of the ruleset */ readonly href?: string; - }; + } | null; }; readonly conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; readonly rules?: readonly components["schemas"]["repository-rule"][]; @@ -26462,6 +27339,7 @@ export interface components { readonly received_events_url?: string; readonly type?: string; readonly site_admin?: boolean; + readonly user_view_type?: string; }[]; readonly teams: readonly { readonly id?: number; @@ -26517,6 +27395,8 @@ export interface components { readonly type?: string; /** @example false */ readonly site_admin?: boolean; + /** @example public */ + readonly user_view_type?: string; }; readonly name?: string; readonly client_id?: string; @@ -27067,7 +27947,10 @@ export interface components { * @description A suite of checks performed on the code of a given code change */ readonly "check-suite": { - /** @example 5 */ + /** + * Format: int64 + * @example 5 + */ readonly id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ readonly node_id: string; @@ -27687,6 +28570,8 @@ export interface components { }; /** @example admin */ readonly role_name: string; + /** @example public */ + readonly user_view_type?: string; }; /** * Repository Invitation @@ -27802,6 +28687,8 @@ export interface components { }; /** @example admin */ readonly role_name: string; + /** @example public */ + readonly user_view_type?: string; } | null; /** * Repository Collaborator Permission @@ -28175,6 +29062,7 @@ export interface components { readonly name: string; readonly path: string; readonly sha: string; + readonly content?: string; /** Format: uri */ readonly url: string; /** Format: uri */ @@ -28188,7 +29076,6 @@ export interface components { readonly size: number; readonly name: string; readonly path: string; - readonly content?: string; readonly sha: string; /** Format: uri */ readonly url: string; @@ -28250,7 +29137,10 @@ export interface components { * @description Content File */ readonly "content-file": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ readonly type: "file"; readonly encoding: string; readonly size: number; @@ -28284,7 +29174,10 @@ export interface components { * @description An object describing a symlink */ readonly "content-symlink": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ readonly type: "symlink"; readonly target: string; readonly size: number; @@ -28313,7 +29206,10 @@ export interface components { * @description An object describing a submodule */ readonly "content-submodule": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ readonly type: "submodule"; /** Format: uri */ readonly submodule_git_url: string; @@ -28442,6 +29338,7 @@ export interface components { readonly contributions: number; readonly email?: string; readonly name?: string; + readonly user_view_type?: string; }; /** @description A Dependabot alert. */ readonly "dependabot-alert": { @@ -28548,6 +29445,11 @@ export interface components { * @example SPDX-2.3 */ readonly spdxVersion: string; + /** + * @description An optional comment about the SPDX document. + * @example Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/ + */ + readonly comment?: string; readonly creationInfo: { /** * @description The date and time the SPDX document was created. @@ -28567,11 +29469,9 @@ export interface components { * @example CC0-1.0 */ readonly dataLicense: string; - /** @description The name of the repository that the SPDX document describes. */ - readonly documentDescribes: readonly string[]; /** * @description The namespace for the SPDX document. - * @example https://github.com/example/dependency_graph/sbom-123 + * @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 */ readonly documentNamespace: string; readonly packages: readonly { @@ -28582,7 +29482,7 @@ export interface components { readonly SPDXID?: string; /** * @description The name of the package. - * @example rubygems:github/github + * @example github/github */ readonly name?: string; /** @@ -28642,6 +29542,17 @@ export interface components { readonly referenceType: string; }[]; }[]; + readonly relationships?: readonly { + /** + * @description The type of relationship between the two SPDX elements. + * @example DEPENDS_ON + */ + readonly relationshipType?: string; + /** @description The SPDX identifier of the package that is the source of the relationship. */ + readonly spdxElementId?: string; + /** @description The SPDX identifier of the package that is the target of the relationship. */ + readonly relatedSpdxElement?: string; + }[]; }; }; /** @@ -28797,7 +29708,7 @@ export interface components { readonly environment: string; /** * Format: uri - * @description Deprecated: the URL to associate with this status. + * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ @@ -30159,12 +31070,12 @@ export interface components { */ readonly path: string; /** - * @description The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. + * @description The line index in the diff to which the comment applies. This field is closing down; use `line` instead. * @example 1 */ readonly position?: number; /** - * @description The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. + * @description The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. * @example 4 */ readonly original_position?: number; @@ -30364,6 +31275,7 @@ export interface components { readonly read_only: boolean; readonly added_by?: string | null; readonly last_used?: string | null; + readonly enabled?: boolean; }; /** * Language @@ -30824,361 +31736,16 @@ export interface components { readonly head: { readonly label: string; readonly ref: string; - readonly repo: { - readonly archive_url: string; - readonly assignees_url: string; - readonly blobs_url: string; - readonly branches_url: string; - readonly collaborators_url: string; - readonly comments_url: string; - readonly commits_url: string; - readonly compare_url: string; - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - readonly git_commits_url: string; - readonly git_refs_url: string; - readonly git_tags_url: string; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly issue_comment_url: string; - readonly issue_events_url: string; - readonly issues_url: string; - readonly keys_url: string; - readonly labels_url: string; - /** Format: uri */ - readonly languages_url: string; - /** Format: uri */ - readonly merges_url: string; - readonly milestones_url: string; - readonly name: string; - readonly notifications_url: string; - readonly owner: { - /** Format: uri */ - readonly avatar_url: string; - readonly events_url: string; - /** Format: uri */ - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string | null; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly login: string; - /** Format: uri */ - readonly organizations_url: string; - /** Format: uri */ - readonly received_events_url: string; - /** Format: uri */ - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - /** Format: uri */ - readonly subscriptions_url: string; - readonly type: string; - /** Format: uri */ - readonly url: string; - }; - readonly private: boolean; - readonly pulls_url: string; - readonly releases_url: string; - /** Format: uri */ - readonly stargazers_url: string; - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly trees_url: string; - /** Format: uri */ - readonly url: string; - readonly clone_url: string; - readonly default_branch: string; - readonly forks: number; - readonly forks_count: number; - readonly git_url: string; - readonly has_downloads: boolean; - readonly has_issues: boolean; - readonly has_projects: boolean; - readonly has_wiki: boolean; - readonly has_pages: boolean; - readonly has_discussions: boolean; - /** Format: uri */ - readonly homepage: string | null; - readonly language: string | null; - readonly master_branch?: string; - readonly archived: boolean; - readonly disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - readonly visibility?: string; - /** Format: uri */ - readonly mirror_url: string | null; - readonly open_issues: number; - readonly open_issues_count: number; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly push: boolean; - readonly triage?: boolean; - readonly pull: boolean; - }; - readonly temp_clone_token?: string; - readonly allow_merge_commit?: boolean; - readonly allow_squash_merge?: boolean; - readonly allow_rebase_merge?: boolean; - readonly license: { - readonly key: string; - readonly name: string; - /** Format: uri */ - readonly url: string | null; - readonly spdx_id: string | null; - readonly node_id: string; - } | null; - /** Format: date-time */ - readonly pushed_at: string; - readonly size: number; - readonly ssh_url: string; - readonly stargazers_count: number; - /** Format: uri */ - readonly svn_url: string; - readonly topics?: readonly string[]; - readonly watchers: number; - readonly watchers_count: number; - /** Format: date-time */ - readonly created_at: string; - /** Format: date-time */ - readonly updated_at: string; - readonly allow_forking?: boolean; - readonly is_template?: boolean; - readonly web_commit_signoff_required?: boolean; - } | null; + readonly repo: components["schemas"]["repository"]; readonly sha: string; - readonly user: { - /** Format: uri */ - readonly avatar_url: string; - readonly events_url: string; - /** Format: uri */ - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string | null; - /** Format: uri */ - readonly html_url: string; - /** Format: int64 */ - readonly id: number; - readonly node_id: string; - readonly login: string; - /** Format: uri */ - readonly organizations_url: string; - /** Format: uri */ - readonly received_events_url: string; - /** Format: uri */ - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - /** Format: uri */ - readonly subscriptions_url: string; - readonly type: string; - /** Format: uri */ - readonly url: string; - }; + readonly user: components["schemas"]["simple-user"]; }; readonly base: { readonly label: string; readonly ref: string; - readonly repo: { - readonly archive_url: string; - readonly assignees_url: string; - readonly blobs_url: string; - readonly branches_url: string; - readonly collaborators_url: string; - readonly comments_url: string; - readonly commits_url: string; - readonly compare_url: string; - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - readonly git_commits_url: string; - readonly git_refs_url: string; - readonly git_tags_url: string; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly is_template?: boolean; - readonly node_id: string; - readonly issue_comment_url: string; - readonly issue_events_url: string; - readonly issues_url: string; - readonly keys_url: string; - readonly labels_url: string; - /** Format: uri */ - readonly languages_url: string; - /** Format: uri */ - readonly merges_url: string; - readonly milestones_url: string; - readonly name: string; - readonly notifications_url: string; - readonly owner: { - /** Format: uri */ - readonly avatar_url: string; - readonly events_url: string; - /** Format: uri */ - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string | null; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly login: string; - /** Format: uri */ - readonly organizations_url: string; - /** Format: uri */ - readonly received_events_url: string; - /** Format: uri */ - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - /** Format: uri */ - readonly subscriptions_url: string; - readonly type: string; - /** Format: uri */ - readonly url: string; - }; - readonly private: boolean; - readonly pulls_url: string; - readonly releases_url: string; - /** Format: uri */ - readonly stargazers_url: string; - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly trees_url: string; - /** Format: uri */ - readonly url: string; - readonly clone_url: string; - readonly default_branch: string; - readonly forks: number; - readonly forks_count: number; - readonly git_url: string; - readonly has_downloads: boolean; - readonly has_issues: boolean; - readonly has_projects: boolean; - readonly has_wiki: boolean; - readonly has_pages: boolean; - readonly has_discussions: boolean; - /** Format: uri */ - readonly homepage: string | null; - readonly language: string | null; - readonly master_branch?: string; - readonly archived: boolean; - readonly disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - readonly visibility?: string; - /** Format: uri */ - readonly mirror_url: string | null; - readonly open_issues: number; - readonly open_issues_count: number; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly push: boolean; - readonly triage?: boolean; - readonly pull: boolean; - }; - readonly temp_clone_token?: string; - readonly allow_merge_commit?: boolean; - readonly allow_squash_merge?: boolean; - readonly allow_rebase_merge?: boolean; - readonly license: components["schemas"]["nullable-license-simple"]; - /** Format: date-time */ - readonly pushed_at: string; - readonly size: number; - readonly ssh_url: string; - readonly stargazers_count: number; - /** Format: uri */ - readonly svn_url: string; - readonly topics?: readonly string[]; - readonly watchers: number; - readonly watchers_count: number; - /** Format: date-time */ - readonly created_at: string; - /** Format: date-time */ - readonly updated_at: string; - readonly allow_forking?: boolean; - readonly web_commit_signoff_required?: boolean; - }; + readonly repo: components["schemas"]["repository"]; readonly sha: string; - readonly user: { - /** Format: uri */ - readonly avatar_url: string; - readonly events_url: string; - /** Format: uri */ - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string | null; - /** Format: uri */ - readonly html_url: string; - /** Format: int64 */ - readonly id: number; - readonly node_id: string; - readonly login: string; - /** Format: uri */ - readonly organizations_url: string; - /** Format: uri */ - readonly received_events_url: string; - /** Format: uri */ - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - /** Format: uri */ - readonly subscriptions_url: string; - readonly type: string; - /** Format: uri */ - readonly url: string; - }; + readonly user: components["schemas"]["simple-user"]; }; readonly _links: { readonly comments: components["schemas"]["link"]; @@ -31552,6 +32119,10 @@ export interface components { * @enum {string} */ readonly validity?: "active" | "inactive" | "unknown"; + /** @description Whether the detected secret was publicly leaked. */ + readonly publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + readonly multi_repo?: boolean | null; }; /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ readonly "secret-scanning-alert-resolution-comment": string | null; @@ -32446,6 +33017,7 @@ export interface components { readonly company?: string | null; /** Format: date-time */ readonly suspended_at?: string | null; + readonly user_view_type?: string; }; /** * Private User @@ -32459,6 +33031,11 @@ export interface components { * @example 1 */ readonly id: number; + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + readonly user_view_type: "private"; /** @example MDQ6VXNlcjE= */ readonly node_id: string; /** @@ -32573,8 +33150,6 @@ export interface components { readonly space: number; readonly private_repos: number; }; - /** Format: date-time */ - readonly suspended_at?: string | null; readonly business_plus?: boolean; readonly ldap_dn?: string; }; @@ -33614,7 +34189,7 @@ export interface components { readonly allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -33675,75 +34250,6 @@ export interface components { /** @description Whether anonymous git access is enabled for this repository */ readonly anonymous_access_enabled?: boolean; }; - /** - * Simple User - * @description The GitHub user that triggered the event. This property is included in every webhook payload. - */ - readonly "simple-user-webhooks": { - readonly name?: string | null; - readonly email?: string | null; - /** @example octocat */ - readonly login: string; - /** @example 1 */ - readonly id: number; - /** @example MDQ6VXNlcjE= */ - readonly node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; - /** - * Format: uri - * @example https://api.github.com/users/octocat - */ - readonly url: string; - /** - * Format: uri - * @example https://github.com/octocat - */ - readonly html_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/followers - */ - readonly followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions - */ - readonly subscriptions_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs - */ - readonly organizations_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/repos - */ - readonly repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events - */ - readonly received_events_url: string; - /** @example User */ - readonly type: string; - readonly site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - readonly starred_at?: string; - }; /** * branch protection rule * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. @@ -33916,6 +34422,7 @@ export interface components { /** Format: uri */ readonly url: string; readonly verified: boolean; + readonly enabled?: boolean; }; /** Workflow */ readonly webhooks_workflow: { @@ -33954,6 +34461,7 @@ export interface components { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly webhooks_reviewers: readonly { /** User */ @@ -34043,6 +34551,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly webhooks_answer: { /** @@ -34114,6 +34623,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** @@ -34159,6 +34669,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly answer_html_url: string | null; /** @@ -34258,6 +34769,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly labels?: readonly components["schemas"]["label"][]; }; @@ -34329,6 +34841,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Label */ @@ -34458,6 +34971,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** @description The changes to the comment. */ @@ -34510,6 +35024,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -34546,6 +35061,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -34633,6 +35149,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -34715,6 +35232,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -34876,6 +35394,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** @@ -34924,6 +35443,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -34992,6 +35512,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -35028,6 +35549,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -35115,6 +35637,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -35197,6 +35720,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -35358,6 +35882,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** User */ @@ -35396,6 +35921,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Marketplace Purchase */ readonly webhooks_marketplace_purchase: { @@ -35975,7 +36501,7 @@ export interface components { readonly allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -36082,6 +36608,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -36155,6 +36682,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** @@ -36221,6 +36749,10 @@ export interface components { }[] | null; /** @description Date and time when the request for access was created. */ readonly created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + readonly token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + readonly token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ readonly token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -36276,6 +36808,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The project card's ID */ readonly id: number; @@ -36332,6 +36865,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: uri */ readonly html_url: string; @@ -36551,7 +37085,7 @@ export interface components { */ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -36639,6 +37173,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -36727,6 +37262,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -36950,6 +37486,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -37059,6 +37596,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -37294,6 +37832,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -37403,6 +37942,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -37470,6 +38010,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -37517,6 +38058,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -37740,6 +38282,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** @@ -37886,6 +38429,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** @description The review that was affected. */ @@ -37959,6 +38503,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly webhooks_nullable_string: string | null; @@ -38065,6 +38610,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly body: string | null; /** Format: date-time */ @@ -38212,6 +38758,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly body: string | null; /** Format: date-time */ @@ -38361,6 +38908,10 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly push_protection_bypassed_at?: string | null; + /** @description Whether the detected secret was publicly leaked. */ + readonly publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + readonly multi_repo?: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ readonly webhooks_security_advisory: { @@ -38421,6 +38972,7 @@ export interface components { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly node_id: string; readonly privacy_level: string; @@ -38460,6 +39012,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** User */ readonly sponsorable: { @@ -38497,6 +39050,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Sponsorship Tier @@ -38608,7 +39162,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** branch protection configuration enabled event */ readonly "webhook-branch-protection-configuration-enabled": { @@ -38618,7 +39172,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** branch protection rule created event */ readonly "webhook-branch-protection-rule-created": { @@ -38629,7 +39183,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly rule: components["schemas"]["webhooks_rule"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ readonly "webhook-branch-protection-rule-deleted": { @@ -38640,7 +39194,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly rule: components["schemas"]["webhooks_rule"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ readonly "webhook-branch-protection-rule-edited": { @@ -38691,7 +39245,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly rule: components["schemas"]["webhooks_rule"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ readonly "webhook-check-run-completed": { @@ -38701,7 +39255,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event @@ -38719,7 +39273,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event @@ -38742,7 +39296,7 @@ export interface components { /** @description The integrator reference of the action requested by the user. */ readonly identifier?: string; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event @@ -38760,7 +39314,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event @@ -38834,6 +39388,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -39011,7 +39566,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** check_suite requested event */ readonly "webhook-check-suite-requested": { @@ -39077,6 +39632,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -39254,7 +39810,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** check_suite rerequested event */ readonly "webhook-check-suite-rerequested": { @@ -39320,6 +39876,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -39497,7 +40054,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert appeared_in_branch event */ readonly "webhook-code-scanning-alert-appeared-in-branch": { @@ -39551,6 +40108,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -39623,7 +40181,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ readonly "webhook-code-scanning-alert-closed-by-user": { @@ -39677,6 +40235,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -39756,7 +40315,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ readonly "webhook-code-scanning-alert-created": { @@ -39831,9 +40390,9 @@ export interface components { }; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - readonly state: "open" | "dismissed"; + readonly state: "open" | "dismissed" | null; readonly tool: { readonly guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -39851,7 +40410,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ readonly "webhook-code-scanning-alert-fixed": { @@ -39905,6 +40464,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -39986,7 +40546,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ readonly "webhook-code-scanning-alert-reopened": { @@ -40079,7 +40639,7 @@ export interface components { /** @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. */ readonly ref: string | null; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ readonly "webhook-code-scanning-alert-reopened-by-user": { @@ -40163,7 +40723,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** commit_comment created event */ readonly "webhook-commit-comment-created": { @@ -40172,7 +40732,7 @@ export interface components { * @enum {string} */ readonly action: "created"; - /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ + /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ readonly comment: { /** * AuthorAssociation @@ -40251,13 +40811,14 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** create event */ readonly "webhook-create": { @@ -40276,7 +40837,7 @@ export interface components { */ readonly ref_type: "tag" | "branch"; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** custom property created event */ readonly "webhook-custom-property-created": { @@ -40286,7 +40847,7 @@ export interface components { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** custom property deleted event */ readonly "webhook-custom-property-deleted": { @@ -40299,7 +40860,7 @@ export interface components { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** custom property updated event */ readonly "webhook-custom-property-updated": { @@ -40309,7 +40870,7 @@ export interface components { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** Custom property values updated event */ readonly "webhook-custom-property-values-updated": { @@ -40319,7 +40880,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; /** @description The new custom property values for the repository. */ readonly new_property_values: readonly components["schemas"]["custom-property-value"][]; /** @description The old custom property values for the repository. */ @@ -40338,7 +40899,7 @@ export interface components { */ readonly ref_type: "tag" | "branch"; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-dismissed event */ readonly "webhook-dependabot-alert-auto-dismissed": { @@ -40349,7 +40910,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-reopened event */ readonly "webhook-dependabot-alert-auto-reopened": { @@ -40360,7 +40921,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ readonly "webhook-dependabot-alert-created": { @@ -40371,7 +40932,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ readonly "webhook-dependabot-alert-dismissed": { @@ -40382,7 +40943,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ readonly "webhook-dependabot-alert-fixed": { @@ -40393,7 +40954,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ readonly "webhook-dependabot-alert-reintroduced": { @@ -40404,7 +40965,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ readonly "webhook-dependabot-alert-reopened": { @@ -40415,7 +40976,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ readonly "webhook-deploy-key-created": { @@ -40426,7 +40987,7 @@ export interface components { readonly key: components["schemas"]["webhooks_deploy_key"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ readonly "webhook-deploy-key-deleted": { @@ -40437,7 +40998,7 @@ export interface components { readonly key: components["schemas"]["webhooks_deploy_key"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** deployment created event */ readonly "webhook-deployment-created": { @@ -40485,6 +41046,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; readonly environment: string; @@ -40547,6 +41109,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -40643,7 +41206,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ readonly workflow_run: { @@ -40683,6 +41246,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly artifacts_url?: string; readonly cancel_url?: string; @@ -40917,6 +41481,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: date-time */ readonly updated_at: string; @@ -40944,7 +41509,7 @@ export interface components { readonly repository?: components["schemas"]["repository-webhooks"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; readonly "webhook-deployment-review-approved": { /** @enum {string} */ @@ -40956,7 +41521,7 @@ export interface components { readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly reviewers?: components["schemas"]["webhooks_reviewers"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly since: string; readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; readonly workflow_job_runs?: readonly { @@ -41007,6 +41572,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly artifacts_url?: string; readonly cancel_url?: string; @@ -41075,6 +41641,7 @@ export interface components { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly private?: boolean; readonly pulls_url?: string; @@ -41185,6 +41752,7 @@ export interface components { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly private?: boolean; readonly pulls_url?: string; @@ -41241,6 +41809,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: date-time */ readonly updated_at: string; @@ -41260,7 +41829,7 @@ export interface components { readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly reviewers?: components["schemas"]["webhooks_reviewers"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly since: string; readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; readonly workflow_job_runs?: readonly { @@ -41311,6 +41880,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly artifacts_url?: string; readonly cancel_url?: string; @@ -41378,6 +41948,7 @@ export interface components { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly private?: boolean; readonly pulls_url?: string; @@ -41488,6 +42059,7 @@ export interface components { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly private?: boolean; readonly pulls_url?: string; @@ -41544,6 +42116,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: date-time */ readonly updated_at: string; @@ -41600,11 +42173,12 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @enum {string} */ readonly type?: "User" | "Team"; }[]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly since: string; readonly workflow_job_run: { readonly conclusion: unknown; @@ -41654,6 +42228,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly artifacts_url?: string; readonly cancel_url?: string; @@ -41721,6 +42296,7 @@ export interface components { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly private?: boolean; readonly pulls_url?: string; @@ -41831,6 +42407,7 @@ export interface components { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly private?: boolean; readonly pulls_url?: string; @@ -41887,6 +42464,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: date-time */ readonly updated_at: string; @@ -41973,6 +42551,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; readonly environment: string; @@ -42035,6 +42614,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -42166,6 +42746,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: uri */ readonly deployment_url: string; @@ -42233,6 +42814,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -42326,7 +42908,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ readonly workflow_run?: { @@ -42366,6 +42948,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly artifacts_url?: string; readonly cancel_url?: string; @@ -42600,6 +43183,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: date-time */ readonly updated_at: string; @@ -42619,7 +43203,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion category changed event */ readonly "webhook-discussion-category-changed": { @@ -42647,7 +43231,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion closed event */ readonly "webhook-discussion-closed": { @@ -42658,7 +43242,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion_comment created event */ readonly "webhook-discussion-comment-created": { @@ -42670,7 +43254,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion_comment deleted event */ readonly "webhook-discussion-comment-deleted": { @@ -42682,7 +43266,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion_comment edited event */ readonly "webhook-discussion-comment-edited": { @@ -42699,7 +43283,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion created event */ readonly "webhook-discussion-created": { @@ -42710,7 +43294,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion deleted event */ readonly "webhook-discussion-deleted": { @@ -42721,7 +43305,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion edited event */ readonly "webhook-discussion-edited": { @@ -42740,7 +43324,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion labeled event */ readonly "webhook-discussion-labeled": { @@ -42752,7 +43336,7 @@ export interface components { readonly label: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ readonly "webhook-discussion-locked": { @@ -42763,7 +43347,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion pinned event */ readonly "webhook-discussion-pinned": { @@ -42774,7 +43358,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion reopened event */ readonly "webhook-discussion-reopened": { @@ -42785,7 +43369,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion transferred event */ readonly "webhook-discussion-transferred": { @@ -42800,7 +43384,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion unanswered event */ readonly "webhook-discussion-unanswered": { @@ -42810,7 +43394,7 @@ export interface components { readonly old_answer: components["schemas"]["webhooks_answer"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ readonly "webhook-discussion-unlabeled": { @@ -42822,7 +43406,7 @@ export interface components { readonly label: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ readonly "webhook-discussion-unlocked": { @@ -42833,7 +43417,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** discussion unpinned event */ readonly "webhook-discussion-unpinned": { @@ -42844,7 +43428,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** * fork event @@ -43040,6 +43624,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -43191,13 +43776,13 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ readonly "webhook-github-app-authorization-revoked": { /** @enum {string} */ readonly action: "revoked"; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** gollum event */ readonly "webhook-gollum": { @@ -43225,7 +43810,7 @@ export interface components { readonly title: string; }[]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** installation created event */ readonly "webhook-installation-created": { @@ -43237,7 +43822,7 @@ export interface components { readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly requester?: components["schemas"]["webhooks_user"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ readonly "webhook-installation-deleted": { @@ -43249,7 +43834,7 @@ export interface components { readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ readonly "webhook-installation-new-permissions-accepted": { @@ -43261,7 +43846,7 @@ export interface components { readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ readonly "webhook-installation-repositories-added": { @@ -43285,7 +43870,7 @@ export interface components { readonly repository?: components["schemas"]["repository-webhooks"]; readonly repository_selection: components["schemas"]["webhooks_repository_selection"]; readonly requester: components["schemas"]["webhooks_user"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ readonly "webhook-installation-repositories-removed": { @@ -43309,7 +43894,7 @@ export interface components { readonly repository?: components["schemas"]["repository-webhooks"]; readonly repository_selection: components["schemas"]["webhooks_repository_selection"]; readonly requester: components["schemas"]["webhooks_user"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ readonly "webhook-installation-suspend": { @@ -43321,7 +43906,7 @@ export interface components { readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; readonly "webhook-installation-target-renamed": { readonly account: { @@ -43361,6 +43946,7 @@ export interface components { readonly updated_at?: string; readonly url?: string; readonly website_url?: unknown; + readonly user_view_type?: string; }; /** @enum {string} */ readonly action: "renamed"; @@ -43376,7 +43962,7 @@ export interface components { readonly installation: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; readonly target_type: string; }; /** installation unsuspend event */ @@ -43389,7 +43975,7 @@ export interface components { readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ readonly "webhook-issue-comment-created": { @@ -43479,6 +44065,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -43523,6 +44110,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -43559,6 +44147,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -43646,6 +44235,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -43728,6 +44318,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -43889,6 +44480,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; } & { readonly active_lock_reason?: string | null; @@ -43928,6 +44520,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees?: readonly Record[]; readonly author_association?: string; @@ -44006,7 +44599,7 @@ export interface components { }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ readonly "webhook-issue-comment-deleted": { @@ -44055,6 +44648,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -44091,6 +44685,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -44178,6 +44773,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -44260,6 +44856,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -44421,6 +45018,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; } & { readonly active_lock_reason?: string | null; @@ -44460,6 +45058,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees?: readonly Record[]; readonly author_association?: string; @@ -44534,11 +45133,12 @@ export interface components { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issue_comment edited event */ readonly "webhook-issue-comment-edited": { @@ -44588,6 +45188,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -44624,6 +45225,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -44711,6 +45313,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -44793,6 +45396,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -44954,6 +45558,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; } & { readonly active_lock_reason?: string | null; @@ -44993,6 +45598,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees?: readonly Record[]; readonly author_association?: string; @@ -45071,7 +45677,7 @@ export interface components { }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues assigned event */ readonly "webhook-issues-assigned": { @@ -45086,7 +45692,7 @@ export interface components { readonly issue: components["schemas"]["webhooks_issue"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues closed event */ readonly "webhook-issues-closed": { @@ -45137,6 +45743,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -45173,6 +45780,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -45260,6 +45868,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -45342,6 +45951,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -45503,6 +46113,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; } & { readonly active_lock_reason?: string | null; @@ -45563,11 +46174,12 @@ export interface components { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues deleted event */ readonly "webhook-issues-deleted": { @@ -45618,6 +46230,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -45741,6 +46354,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -45823,6 +46437,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -45984,11 +46599,12 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues demilestoned event */ readonly "webhook-issues-demilestoned": { @@ -46162,6 +46778,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -46244,6 +46861,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -46405,12 +47023,13 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly milestone?: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues edited event */ readonly "webhook-issues-edited": { @@ -46472,6 +47091,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -46595,6 +47215,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -46677,6 +47298,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -46838,12 +47460,13 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly label?: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues labeled event */ readonly "webhook-issues-labeled": { @@ -46894,6 +47517,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -47017,6 +47641,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -47099,6 +47724,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -47260,12 +47886,13 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly label?: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues locked event */ readonly "webhook-issues-locked": { @@ -47316,6 +47943,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -47352,6 +47980,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47440,6 +48069,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -47522,6 +48152,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -47683,11 +48314,12 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ readonly "webhook-issues-milestoned": { @@ -47861,6 +48493,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -47943,6 +48576,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -48104,12 +48738,13 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly milestone: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues opened event */ readonly "webhook-issues-opened": { @@ -48159,6 +48794,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -48195,6 +48831,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48282,6 +48919,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -48364,6 +49002,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -48525,6 +49164,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; } | null; /** @@ -48724,6 +49364,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -48819,6 +49460,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -48855,6 +49497,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48942,6 +49585,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -49024,6 +49668,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -49185,11 +49830,12 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ readonly "webhook-issues-pinned": { @@ -49200,7 +49846,7 @@ export interface components { readonly issue: components["schemas"]["webhooks_issue_2"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ readonly "webhook-issues-reopened": { @@ -49374,6 +50020,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -49456,6 +50103,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -49617,11 +50265,12 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ readonly "webhook-issues-transferred": { @@ -49671,6 +50320,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -49707,6 +50357,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -49794,6 +50445,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -49876,6 +50528,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -50037,6 +50690,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** @@ -50239,6 +50893,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -50294,7 +50949,7 @@ export interface components { readonly issue: components["schemas"]["webhooks_issue_2"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ readonly "webhook-issues-unassigned": { @@ -50309,7 +50964,7 @@ export interface components { readonly issue: components["schemas"]["webhooks_issue"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ readonly "webhook-issues-unlabeled": { @@ -50321,7 +50976,7 @@ export interface components { readonly label?: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ readonly "webhook-issues-unlocked": { @@ -50372,6 +51027,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -50408,6 +51064,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -50496,6 +51153,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -50578,6 +51236,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ readonly permissions?: { @@ -50739,11 +51398,12 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ readonly "webhook-issues-unpinned": { @@ -50754,7 +51414,7 @@ export interface components { readonly issue: components["schemas"]["webhooks_issue_2"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** label created event */ readonly "webhook-label-created": { @@ -50765,7 +51425,7 @@ export interface components { readonly label: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ readonly "webhook-label-deleted": { @@ -50776,7 +51436,7 @@ export interface components { readonly label: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** label edited event */ readonly "webhook-label-edited": { @@ -50802,7 +51462,7 @@ export interface components { readonly label: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase cancelled event */ readonly "webhook-marketplace-purchase-cancelled": { @@ -50815,7 +51475,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase changed event */ readonly "webhook-marketplace-purchase-changed": { @@ -50854,7 +51514,7 @@ export interface components { readonly unit_count: number; }; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change event */ readonly "webhook-marketplace-purchase-pending-change": { @@ -50893,7 +51553,7 @@ export interface components { readonly unit_count: number; }; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change_cancelled event */ readonly "webhook-marketplace-purchase-pending-change-cancelled": { @@ -50932,7 +51592,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase purchased event */ readonly "webhook-marketplace-purchase-purchased": { @@ -50945,7 +51605,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** member added event */ readonly "webhook-member-added": { @@ -50970,7 +51630,7 @@ export interface components { readonly member: components["schemas"]["webhooks_user"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** member edited event */ readonly "webhook-member-edited": { @@ -50992,7 +51652,7 @@ export interface components { readonly member: components["schemas"]["webhooks_user"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** member removed event */ readonly "webhook-member-removed": { @@ -51003,7 +51663,7 @@ export interface components { readonly member: components["schemas"]["webhooks_user"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** membership added event */ readonly "webhook-membership-added": { @@ -51055,6 +51715,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly team: components["schemas"]["webhooks_team"]; }; @@ -51108,6 +51769,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly team: components["schemas"]["webhooks_team"]; }; @@ -51118,7 +51780,7 @@ export interface components { readonly merge_group: components["schemas"]["merge-group"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; readonly "webhook-merge-group-destroyed": { /** @enum {string} */ @@ -51132,7 +51794,7 @@ export interface components { readonly merge_group: components["schemas"]["merge-group"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** meta deleted event */ readonly "webhook-meta-deleted": { @@ -51162,7 +51824,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ readonly "webhook-milestone-closed": { @@ -51173,7 +51835,7 @@ export interface components { readonly milestone: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** milestone created event */ readonly "webhook-milestone-created": { @@ -51184,7 +51846,7 @@ export interface components { readonly milestone: components["schemas"]["webhooks_milestone_3"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ readonly "webhook-milestone-deleted": { @@ -51195,7 +51857,7 @@ export interface components { readonly milestone: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ readonly "webhook-milestone-edited": { @@ -51221,7 +51883,7 @@ export interface components { readonly milestone: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ readonly "webhook-milestone-opened": { @@ -51232,7 +51894,7 @@ export interface components { readonly milestone: components["schemas"]["webhooks_milestone_3"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** org_block blocked event */ readonly "webhook-org-block-blocked": { @@ -51243,7 +51905,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** org_block unblocked event */ readonly "webhook-org-block-unblocked": { @@ -51254,7 +51916,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** organization deleted event */ readonly "webhook-organization-deleted": { @@ -51265,7 +51927,7 @@ export interface components { readonly membership?: components["schemas"]["webhooks_membership"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ readonly "webhook-organization-member-added": { @@ -51276,7 +51938,7 @@ export interface components { readonly membership: components["schemas"]["webhooks_membership"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ readonly "webhook-organization-member-invited": { @@ -51331,6 +51993,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly login: string | null; readonly node_id: string; @@ -51340,7 +52003,7 @@ export interface components { }; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ @@ -51352,7 +52015,7 @@ export interface components { readonly membership: components["schemas"]["webhooks_membership"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ readonly "webhook-organization-renamed": { @@ -51368,7 +52031,7 @@ export interface components { readonly membership?: components["schemas"]["webhooks_membership"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ readonly "webhook-rubygems-metadata": { @@ -51442,6 +52105,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly package_type: string; readonly package_version: { @@ -51481,6 +52145,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly body?: string | Record; readonly body_html?: string; @@ -51609,6 +52274,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly created_at: string; readonly draft: boolean; @@ -51644,7 +52310,7 @@ export interface components { readonly updated_at: string | null; }; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** package updated event */ readonly "webhook-package-updated": { @@ -51699,6 +52365,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly package_type: string; readonly package_version: { @@ -51738,6 +52405,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly body: string; readonly body_html: string; @@ -51809,6 +52477,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly created_at: string; readonly draft: boolean; @@ -51845,7 +52514,7 @@ export interface components { readonly updated_at: string; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** page_build event */ readonly "webhook-page-build": { @@ -51893,6 +52562,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly status: string; readonly updated_at: string; @@ -51904,7 +52574,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** personal_access_token_request approved event */ readonly "webhook-personal-access-token-request-approved": { @@ -51913,7 +52583,7 @@ export interface components { readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request cancelled event */ @@ -51923,7 +52593,7 @@ export interface components { readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request created event */ @@ -51933,7 +52603,7 @@ export interface components { readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly installation?: components["schemas"]["simple-installation"]; }; /** personal_access_token_request denied event */ @@ -51943,7 +52613,7 @@ export interface components { readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly installation: components["schemas"]["simple-installation"]; }; readonly "webhook-ping": { @@ -51990,7 +52660,7 @@ export interface components { readonly hook_id?: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ readonly zen?: string; }; @@ -52013,7 +52683,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_card: components["schemas"]["webhooks_project_card"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project_card created event */ readonly "webhook-project-card-created": { @@ -52024,7 +52694,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_card: components["schemas"]["webhooks_project_card"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ readonly "webhook-project-card-deleted": { @@ -52081,6 +52751,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The project card's ID */ readonly id: number; @@ -52094,7 +52765,7 @@ export interface components { readonly url: string; }; readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ readonly "webhook-project-card-edited": { @@ -52110,7 +52781,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_card: components["schemas"]["webhooks_project_card"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ readonly "webhook-project-card-moved": { @@ -52171,6 +52842,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description The project card's ID */ readonly id: number; @@ -52216,7 +52888,7 @@ export interface components { readonly url?: string; }; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project closed event */ readonly "webhook-project-closed": { @@ -52227,7 +52899,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project: components["schemas"]["webhooks_project"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project_column created event */ readonly "webhook-project-column-created": { @@ -52238,7 +52910,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_column: components["schemas"]["webhooks_project_column"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ readonly "webhook-project-column-deleted": { @@ -52249,7 +52921,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_column: components["schemas"]["webhooks_project_column"]; readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ readonly "webhook-project-column-edited": { @@ -52265,7 +52937,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_column: components["schemas"]["webhooks_project_column"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ readonly "webhook-project-column-moved": { @@ -52276,7 +52948,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project_column: components["schemas"]["webhooks_project_column"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project created event */ readonly "webhook-project-created": { @@ -52287,7 +52959,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project: components["schemas"]["webhooks_project"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** project deleted event */ readonly "webhook-project-deleted": { @@ -52298,7 +52970,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project: components["schemas"]["webhooks_project"]; readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** project edited event */ readonly "webhook-project-edited": { @@ -52320,7 +52992,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project: components["schemas"]["webhooks_project"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ readonly "webhook-project-reopened": { @@ -52331,7 +53003,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly project: components["schemas"]["webhooks_project"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ readonly "webhook-projects-v2-project-closed": { @@ -52340,7 +53012,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ readonly "webhook-projects-v2-project-created": { @@ -52349,7 +53021,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ readonly "webhook-projects-v2-project-deleted": { @@ -52358,7 +53030,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ readonly "webhook-projects-v2-project-edited": { @@ -52385,7 +53057,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ readonly "webhook-projects-v2-item-archived": { @@ -52395,7 +53067,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ readonly "webhook-projects-v2-item-converted": { @@ -52410,7 +53082,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ readonly "webhook-projects-v2-item-created": { @@ -52419,7 +53091,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ readonly "webhook-projects-v2-item-deleted": { @@ -52428,7 +53100,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ readonly "webhook-projects-v2-item-edited": { @@ -52454,7 +53126,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ readonly "webhook-projects-v2-item-reordered": { @@ -52469,7 +53141,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ readonly "webhook-projects-v2-item-restored": { @@ -52479,7 +53151,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ readonly "webhook-projects-v2-project-reopened": { @@ -52488,7 +53160,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Created Event */ readonly "webhook-projects-v2-status-update-created": { @@ -52497,7 +53169,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Deleted Event */ readonly "webhook-projects-v2-status-update-deleted": { @@ -52506,7 +53178,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Edited Event */ readonly "webhook-projects-v2-status-update-edited": { @@ -52539,7 +53211,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization: components["schemas"]["organization-simple-webhooks"]; readonly projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** public event */ readonly "webhook-public": { @@ -52547,7 +53219,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request assigned event */ readonly "webhook-pull-request-assigned": { @@ -52641,6 +53313,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -52677,6 +53350,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -52729,6 +53403,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -52952,6 +53627,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -53012,7 +53688,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -53061,6 +53737,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -53296,6 +53973,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -53356,7 +54034,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -53405,6 +54083,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -53472,6 +54151,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -53519,6 +54199,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -53585,6 +54266,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -53742,10 +54424,11 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ readonly "webhook-pull-request-auto-merge-disabled": { @@ -53838,6 +54521,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -53926,6 +54610,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -54149,6 +54834,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -54209,7 +54895,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -54258,6 +54944,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -54493,6 +55180,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -54553,7 +55241,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -54602,6 +55290,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -54669,6 +55358,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -54716,6 +55406,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -54782,6 +55473,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -54939,11 +55631,12 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly reason: string; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ readonly "webhook-pull-request-auto-merge-enabled": { @@ -55036,6 +55729,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -55124,6 +55818,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -55347,6 +56042,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -55407,7 +56103,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -55456,6 +56152,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -55688,6 +56385,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -55748,7 +56446,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -55797,6 +56495,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -55864,6 +56563,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -55911,6 +56611,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -55977,6 +56678,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -56134,11 +56836,12 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly reason?: string; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ readonly "webhook-pull-request-closed": { @@ -56150,7 +56853,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["pull-request-webhook"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ readonly "webhook-pull-request-converted-to-draft": { @@ -56162,7 +56865,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["pull-request-webhook"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ readonly "webhook-pull-request-demilestoned": { @@ -56174,7 +56877,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["webhooks_pull_request_5"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** pull_request dequeued event */ readonly "webhook-pull-request-dequeued": { @@ -56267,6 +56970,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -56355,6 +57059,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -56578,6 +57283,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -56638,7 +57344,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -56687,6 +57393,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -56922,6 +57629,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -56982,7 +57690,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -57031,6 +57739,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -57098,6 +57807,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -57145,6 +57855,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -57211,6 +57922,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -57368,11 +58080,13 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; - readonly reason: string; + /** @enum {string} */ + readonly reason: "UNKNOWN_REMOVAL_REASON" | "MANUAL" | "MERGE" | "MERGE_CONFLICT" | "CI_FAILURE" | "CI_TIMEOUT" | "ALREADY_MERGED" | "QUEUE_CLEARED" | "ROLL_BACK" | "BRANCH_PROTECTIONS" | "GIT_TREE_INVALID" | "INVALID_MERGE_COMMIT"; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request edited event */ readonly "webhook-pull-request-edited": { @@ -57403,7 +58117,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["pull-request-webhook"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** pull_request enqueued event */ readonly "webhook-pull-request-enqueued": { @@ -57496,6 +58210,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -57584,6 +58299,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -57807,6 +58523,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -57867,7 +58584,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -57916,6 +58633,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -58151,6 +58869,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -58211,7 +58930,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -58260,6 +58979,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -58327,6 +59047,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -58374,6 +59095,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -58440,6 +59162,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -58597,10 +59320,11 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ readonly "webhook-pull-request-labeled": { @@ -58694,6 +59418,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -58782,6 +59507,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -59005,6 +59731,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -59065,7 +59792,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -59114,6 +59841,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -59349,6 +60077,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -59409,7 +60138,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -59458,6 +60187,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -59525,6 +60255,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -59572,6 +60303,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -59638,6 +60370,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -59795,10 +60528,11 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ readonly "webhook-pull-request-locked": { @@ -59891,6 +60625,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -59979,6 +60714,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -60202,6 +60938,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -60262,7 +60999,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -60311,6 +61048,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -60546,6 +61284,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -60606,7 +61345,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -60655,6 +61394,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -60722,6 +61462,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -60769,6 +61510,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -60835,6 +61577,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -60992,10 +61735,11 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ readonly "webhook-pull-request-milestoned": { @@ -61007,7 +61751,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["webhooks_pull_request_5"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ readonly "webhook-pull-request-opened": { @@ -61019,7 +61763,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["pull-request-webhook"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ readonly "webhook-pull-request-ready-for-review": { @@ -61031,7 +61775,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["pull-request-webhook"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ readonly "webhook-pull-request-reopened": { @@ -61043,7 +61787,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly pull_request: components["schemas"]["pull-request-webhook"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ readonly "webhook-pull-request-review-comment-created": { @@ -61193,6 +61937,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -61279,6 +62024,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -61367,6 +62113,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -61590,6 +62337,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -61650,7 +62398,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -61699,6 +62447,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -61927,6 +62676,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -61987,7 +62737,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -62036,6 +62786,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -62107,6 +62858,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -62171,6 +62923,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -62322,10 +63075,11 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ readonly "webhook-pull-request-review-comment-deleted": { @@ -62416,6 +63170,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -62504,6 +63259,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -62727,6 +63483,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -62787,7 +63544,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -62836,6 +63593,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -63064,6 +63822,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -63124,7 +63883,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -63173,6 +63932,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -63244,6 +64004,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -63308,6 +64069,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -63459,10 +64221,11 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ readonly "webhook-pull-request-review-comment-edited": { @@ -63554,6 +64317,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -63590,6 +64354,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -63642,6 +64407,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -63865,6 +64631,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -63925,7 +64692,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -63974,6 +64741,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -64202,6 +64970,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -64262,7 +65031,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -64311,6 +65080,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -64382,6 +65152,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -64446,6 +65217,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -64595,12 +65367,13 @@ export interface components { readonly subscriptions_url?: string; /** @enum {string} */ readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly user_view_type?: string; /** Format: uri */ readonly url?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ readonly "webhook-pull-request-review-dismissed": { @@ -64691,6 +65464,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -64779,6 +65553,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -65002,6 +65777,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -65062,7 +65838,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -65111,6 +65887,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -65339,6 +66116,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -65399,7 +66177,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -65448,6 +66226,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -65519,6 +66298,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -65583,6 +66363,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -65734,6 +66515,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; @@ -65809,9 +66591,10 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ readonly "webhook-pull-request-review-edited": { @@ -65908,6 +66691,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -65996,6 +66780,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -66197,6 +66982,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -66282,6 +67068,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -66488,6 +67275,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -66573,6 +67361,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -66644,6 +67433,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -66708,6 +67498,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -66859,11 +67650,12 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; readonly review: components["schemas"]["webhooks_review"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ readonly "webhook-pull-request-review-request-removed": { @@ -66957,6 +67749,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -66993,6 +67786,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -67045,6 +67839,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -67268,6 +68063,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -67321,7 +68117,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -67370,6 +68166,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -67605,6 +68402,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -67665,7 +68463,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -67714,6 +68512,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -67781,6 +68580,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -67828,6 +68628,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -67894,6 +68695,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -68051,6 +68853,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; @@ -68090,8 +68893,9 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ readonly action: "review_request_removed"; @@ -68183,6 +68987,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -68219,6 +69024,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -68271,6 +69077,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -68494,6 +69301,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -68554,7 +69362,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -68603,6 +69411,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -68838,6 +69647,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -68898,7 +69708,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -68947,6 +69757,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -69014,6 +69825,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -69061,6 +69873,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -69127,6 +69940,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -69284,6 +70098,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; @@ -69342,7 +70157,7 @@ export interface components { */ readonly url: string; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request review_requested event */ readonly "webhook-pull-request-review-requested": { @@ -69436,6 +70251,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -69472,6 +70288,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -69524,6 +70341,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -69747,6 +70565,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -69807,7 +70626,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -69856,6 +70675,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -70091,6 +70911,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -70151,7 +70972,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -70200,6 +71021,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -70267,6 +71089,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -70314,6 +71137,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -70380,6 +71204,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -70537,6 +71362,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; @@ -70576,8 +71402,9 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ readonly action: "review_requested"; @@ -70669,6 +71496,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -70705,6 +71533,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -70757,6 +71586,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -70980,6 +71810,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -71040,7 +71871,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -71089,6 +71920,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -71324,6 +72156,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -71384,7 +72217,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -71433,6 +72266,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -71500,6 +72334,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -71547,6 +72382,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -71613,6 +72449,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -71770,6 +72607,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; @@ -71828,7 +72666,7 @@ export interface components { */ readonly url?: string; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request_review submitted event */ readonly "webhook-pull-request-review-submitted": { @@ -71919,6 +72757,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -72007,6 +72846,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -72230,6 +73070,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -72290,7 +73131,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -72339,6 +73180,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -72567,6 +73409,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -72627,7 +73470,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -72676,6 +73519,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -72747,6 +73591,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -72811,6 +73656,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -72962,11 +73808,12 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; readonly review: components["schemas"]["webhooks_review"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ readonly "webhook-pull-request-review-thread-resolved": { @@ -73057,6 +73904,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -73145,6 +73993,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -73351,6 +74200,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -73438,6 +74288,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -73649,6 +74500,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -73736,6 +74588,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -73807,6 +74660,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -73871,6 +74725,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -74022,10 +74877,11 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; readonly thread: { readonly comments: readonly { readonly _links: { @@ -74167,6 +75023,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }[]; readonly node_id: string; @@ -74261,6 +75118,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -74349,6 +75207,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -74555,6 +75414,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -74642,6 +75502,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -74853,6 +75714,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -74940,6 +75802,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -75011,6 +75874,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -75075,6 +75939,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -75226,10 +76091,11 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; readonly thread: { readonly comments: readonly { readonly _links: { @@ -75371,6 +76237,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }[]; readonly node_id: string; @@ -75469,6 +76336,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -75557,6 +76425,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -75780,6 +76649,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -75840,7 +76710,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -75889,6 +76759,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -76117,6 +76988,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -76177,7 +77049,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -76226,6 +77098,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -76293,6 +77166,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -76340,6 +77214,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -76406,6 +77281,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -76563,10 +77439,11 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ readonly "webhook-pull-request-unassigned": { @@ -76660,6 +77537,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -76748,6 +77626,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -76971,6 +77850,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -77031,7 +77911,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -77080,6 +77960,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -77315,6 +78196,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -77375,7 +78257,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -77424,6 +78306,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -77491,6 +78374,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -77538,6 +78422,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -77604,6 +78489,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -77761,10 +78647,11 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ readonly "webhook-pull-request-unlabeled": { @@ -77858,6 +78745,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -77946,6 +78834,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -78169,6 +79058,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -78229,7 +79119,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -78278,6 +79168,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -78506,6 +79397,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -78566,7 +79458,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -78615,6 +79507,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -78682,6 +79575,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -78729,6 +79623,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -78795,6 +79690,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -78952,10 +79848,11 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ readonly "webhook-pull-request-unlocked": { @@ -79048,6 +79945,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -79136,6 +80034,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * @description The merge method to use. @@ -79359,6 +80258,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -79419,7 +80319,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -79468,6 +80368,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly body: string | null; @@ -79703,6 +80604,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -79763,7 +80665,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -79812,6 +80714,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; /** Format: uri */ @@ -79879,6 +80782,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** * Milestone @@ -79926,6 +80830,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly description: string | null; /** Format: date-time */ @@ -79992,6 +80897,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ @@ -80149,10 +81055,11 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** push event */ readonly "webhook-push": { @@ -80489,6 +81396,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -80538,7 +81446,7 @@ export interface components { /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; readonly "webhook-registry-package-published": { /** @enum {string} */ @@ -80573,6 +81481,7 @@ export interface components { readonly subscriptions_url: string; readonly type: string; readonly url: string; + readonly user_view_type?: string; }; readonly package_type: string; readonly package_version: { @@ -80595,6 +81504,7 @@ export interface components { readonly subscriptions_url: string; readonly type: string; readonly url: string; + readonly user_view_type?: string; }; readonly body?: string | Record; readonly body_html?: string; @@ -80704,6 +81614,7 @@ export interface components { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; readonly created_at?: string; readonly draft?: boolean; @@ -80734,7 +81645,7 @@ export interface components { readonly updated_at: string | null; }; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; readonly "webhook-registry-package-updated": { /** @enum {string} */ @@ -80769,6 +81680,7 @@ export interface components { readonly subscriptions_url: string; readonly type: string; readonly url: string; + readonly user_view_type?: string; }; readonly package_type: string; readonly package_version: { @@ -80791,6 +81703,7 @@ export interface components { readonly subscriptions_url: string; readonly type: string; readonly url: string; + readonly user_view_type?: string; }; readonly body: string; readonly body_html: string; @@ -80843,6 +81756,7 @@ export interface components { readonly subscriptions_url: string; readonly type: string; readonly url: string; + readonly user_view_type?: string; }; readonly created_at: string; readonly draft: boolean; @@ -80867,7 +81781,7 @@ export interface components { readonly updated_at: string; }; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** release created event */ readonly "webhook-release-created": { @@ -80878,7 +81792,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly release: components["schemas"]["webhooks_release"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** release deleted event */ readonly "webhook-release-deleted": { @@ -80889,7 +81803,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly release: components["schemas"]["webhooks_release"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** release edited event */ readonly "webhook-release-edited": { @@ -80914,7 +81828,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly release: components["schemas"]["webhooks_release"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ readonly "webhook-release-prereleased": { @@ -81026,6 +81940,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly body: string | null; /** Format: date-time */ @@ -81074,7 +81989,7 @@ export interface components { readonly zipball_url: string | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** release published event */ readonly "webhook-release-published": { @@ -81085,7 +82000,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly release: components["schemas"]["webhooks_release_1"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** release released event */ readonly "webhook-release-released": { @@ -81096,7 +82011,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly release: components["schemas"]["webhooks_release"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ readonly "webhook-release-unpublished": { @@ -81107,7 +82022,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly release: components["schemas"]["webhooks_release_1"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** Repository advisory published event */ readonly "webhook-repository-advisory-published": { @@ -81118,7 +82033,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly repository_advisory: components["schemas"]["repository-advisory"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** Repository advisory reported event */ readonly "webhook-repository-advisory-reported": { @@ -81129,7 +82044,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly repository_advisory: components["schemas"]["repository-advisory"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ readonly "webhook-repository-archived": { @@ -81139,7 +82054,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository created event */ readonly "webhook-repository-created": { @@ -81149,7 +82064,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository deleted event */ readonly "webhook-repository-deleted": { @@ -81159,7 +82074,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository_dispatch event */ readonly "webhook-repository-dispatch-sample": { @@ -81174,7 +82089,7 @@ export interface components { readonly installation: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository edited event */ readonly "webhook-repository-edited": { @@ -81198,7 +82113,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository_import event */ readonly "webhook-repository-import": { @@ -81206,7 +82121,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; /** @enum {string} */ readonly status: "success" | "cancelled" | "failure"; }; @@ -81218,7 +82133,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository publicized event */ readonly "webhook-repository-publicized": { @@ -81228,7 +82143,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository renamed event */ readonly "webhook-repository-renamed": { @@ -81245,7 +82160,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository ruleset created event */ readonly "webhook-repository-ruleset-created": { @@ -81256,7 +82171,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository ruleset deleted event */ readonly "webhook-repository-ruleset-deleted": { @@ -81267,7 +82182,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository ruleset edited event */ readonly "webhook-repository-ruleset-edited": { @@ -81325,7 +82240,7 @@ export interface components { }[]; }; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ readonly "webhook-repository-transferred": { @@ -81396,6 +82311,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; }; }; @@ -81404,7 +82320,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository unarchived event */ readonly "webhook-repository-unarchived": { @@ -81414,7 +82330,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert create event */ readonly "webhook-repository-vulnerability-alert-create": { @@ -81425,7 +82341,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert dismiss event */ readonly "webhook-repository-vulnerability-alert-dismiss": { @@ -81478,6 +82394,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly external_identifier: string; /** Format: uri */ @@ -81498,7 +82415,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert reopen event */ readonly "webhook-repository-vulnerability-alert-reopen": { @@ -81509,7 +82426,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert resolve event */ readonly "webhook-repository-vulnerability-alert-resolve": { @@ -81581,7 +82498,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** secret_scanning_alert created event */ readonly "webhook-secret-scanning-alert-created": { @@ -81592,7 +82509,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ readonly "webhook-secret-scanning-alert-location-created": { @@ -81603,13 +82520,24 @@ export interface components { readonly location: components["schemas"]["secret-scanning-location"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ readonly "webhook-secret-scanning-alert-location-created-form-encoded": { /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ readonly payload: string; }; + /** secret_scanning_alert publicly leaked event */ + readonly "webhook-secret-scanning-alert-publicly-leaked": { + /** @enum {string} */ + readonly action: "publicly_leaked"; + readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; + }; /** secret_scanning_alert reopened event */ readonly "webhook-secret-scanning-alert-reopened": { /** @enum {string} */ @@ -81619,7 +82547,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert resolved event */ readonly "webhook-secret-scanning-alert-resolved": { @@ -81630,7 +82558,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert validated event */ readonly "webhook-secret-scanning-alert-validated": { @@ -81641,7 +82569,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ readonly "webhook-security-advisory-published": { @@ -81652,7 +82580,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly security_advisory: components["schemas"]["webhooks_security_advisory"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ readonly "webhook-security-advisory-updated": { @@ -81663,7 +82591,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly security_advisory: components["schemas"]["webhooks_security_advisory"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ readonly "webhook-security-advisory-withdrawn": { @@ -81711,7 +82639,7 @@ export interface components { }[]; readonly withdrawn_at: string; }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ readonly "webhook-security-and-analysis": { @@ -81724,7 +82652,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["full-repository"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ readonly "webhook-sponsorship-cancelled": { @@ -81734,7 +82662,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ @@ -81745,7 +82673,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ @@ -81762,7 +82690,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ @@ -81774,7 +82702,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ @@ -81787,7 +82715,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ @@ -81799,7 +82727,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ @@ -81810,7 +82738,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ readonly starred_at: string | null; }; @@ -81822,7 +82750,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ readonly starred_at: unknown; }; @@ -81986,7 +82914,7 @@ export interface components { readonly name: string; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ readonly sha: string; /** @@ -82012,7 +82940,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** parent issue removed event */ readonly "webhook-sub-issues-parent-issue-removed": { @@ -82028,7 +82956,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** sub-issue added event */ readonly "webhook-sub-issues-sub-issue-added": { @@ -82044,7 +82972,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** sub-issue removed event */ readonly "webhook-sub-issues-sub-issue-removed": { @@ -82060,7 +82988,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; }; /** team_add event */ readonly "webhook-team-add": { @@ -82068,7 +82996,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ @@ -82273,6 +83201,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -82320,7 +83249,7 @@ export interface components { readonly watchers: number; readonly watchers_count: number; }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; readonly team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ @@ -82525,6 +83454,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -82572,7 +83502,7 @@ export interface components { readonly watchers: number; readonly watchers_count: number; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ @@ -82777,6 +83707,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -82824,7 +83755,7 @@ export interface components { readonly watchers: number; readonly watchers_count: number; }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; readonly team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ @@ -83060,6 +83991,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -83107,7 +84039,7 @@ export interface components { readonly watchers: number; readonly watchers_count: number; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ @@ -83312,6 +84244,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly permissions?: { readonly admin: boolean; @@ -83359,7 +84292,7 @@ export interface components { readonly watchers: number; readonly watchers_count: number; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ @@ -83370,7 +84303,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; }; /** workflow_dispatch event */ readonly "webhook-workflow-dispatch": { @@ -83382,7 +84315,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly ref: string; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow: string; }; /** workflow_job completed event */ @@ -83393,7 +84326,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { /** Format: uri */ readonly check_run_url: string; @@ -83483,7 +84416,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { /** Format: uri */ readonly check_run_url: string; @@ -83581,7 +84514,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { /** Format: uri */ readonly check_run_url: string; @@ -83635,7 +84568,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow_job: { /** Format: uri */ readonly check_run_url: string; @@ -83689,7 +84622,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ readonly workflow_run: { @@ -83729,6 +84662,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: uri */ readonly artifacts_url: string; @@ -83879,6 +84813,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; @@ -84051,6 +84986,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; @@ -84119,6 +85055,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: date-time */ readonly updated_at: string; @@ -84142,7 +85079,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ readonly workflow_run: { @@ -84590,7 +85527,7 @@ export interface components { readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; readonly workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ readonly workflow_run: { @@ -84630,6 +85567,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: uri */ readonly artifacts_url: string; @@ -84780,6 +85718,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; @@ -84952,6 +85891,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ readonly private: boolean; @@ -85020,6 +85960,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; /** Format: date-time */ readonly updated_at: string; @@ -85113,6 +86054,15 @@ export interface components { readonly "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + readonly usage_metrics_api_disabled: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Service unavailable */ readonly service_unavailable: { headers: { @@ -85361,6 +86311,12 @@ export interface components { readonly "secret-scanning-alert-sort": "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ readonly "secret-scanning-alert-validity": string; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + readonly "secret-scanning-alert-publicly-leaked": boolean; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + readonly "secret-scanning-alert-multi-repo": boolean; + /** @description The slug of the enterprise team name. */ + readonly "enterprise-team-slug": string; /** @description The slug of the team name. */ readonly "team-slug": string; /** @description The unique identifier of the gist. */ @@ -85393,6 +86349,10 @@ export interface components { readonly org: string; /** @description The unique identifier of the repository. */ readonly "repository-id": number; + /** @description Only return runner groups that are allowed to be used by this repository. */ + readonly "visible-to-repository": string; + /** @description Unique identifier of the self-hosted runner group. */ + readonly "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ readonly "runner-id": number; /** @description The name of a self-hosted runner's custom label. */ @@ -85413,6 +86373,22 @@ export interface components { readonly "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ readonly "hook-id": number; + /** @description The type of the actor */ + readonly "api-insights-actor-type": "installations" | "classic_pats" | "fine_grained_pats" | "oauth_apps" | "github_apps_user_to_server"; + /** @description The ID of the actor */ + readonly "api-insights-actor-id": number; + /** @description The minimum timestamp to query for stats */ + readonly "api-insights-min-timestamp": string; + /** @description The maximum timestamp to query for stats */ + readonly "api-insights-max-timestamp": string; + /** @description The property to sort the results by. */ + readonly "api-insights-route-stats-sort": readonly ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[]; + /** @description The property to sort the results by. */ + readonly "api-insights-sort": readonly ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[]; + /** @description The ID of the user to query for stats */ + readonly "api-insights-user-id": string; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + readonly "api-insights-timestamp-increment": string; /** @description The unique identifier of the invitation. */ readonly "invitation-id": number; /** @description The name of the codespace. */ @@ -85448,8 +86424,13 @@ export interface components { readonly "personal-access-token-after": string; /** @description The unique identifier of the fine-grained personal access token. */ readonly "fine-grained-personal-access-token-id": number; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ readonly "custom-property-name": string; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + readonly "ruleset-targets": string; /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ readonly "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ @@ -85542,6 +86523,8 @@ export interface components { readonly status: "queued" | "in_progress" | "completed"; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ readonly "git-ref": components["schemas"]["code-scanning-ref"]; + /** @description The number of the pull request for the results you want to list. */ + readonly "pr-alias": number; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ readonly "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -85865,7 +86848,6 @@ export interface operations { readonly per_page?: components["parameters"]["per-page"]; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ readonly cursor?: components["parameters"]["cursor"]; - readonly redelivery?: boolean; }; readonly header?: never; readonly path?: never; @@ -86340,7 +87322,7 @@ export interface operations { readonly 404: components["responses"]["not_found"]; }; }; - readonly "classroom/list-accepted-assigments-for-an-assignment": { + readonly "classroom/list-accepted-assignments-for-an-assignment": { readonly parameters: { readonly query?: { /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -86574,6 +87556,42 @@ export interface operations { readonly 500: components["responses"]["internal_error"]; }; }; + readonly "copilot/copilot-metrics-for-enterprise": { + readonly parameters: { + readonly query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + readonly since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + readonly until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: number; + }; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["usage_metrics_api_disabled"]; + readonly 500: components["responses"]["internal_error"]; + }; + }; readonly "copilot/usage-metrics-for-enterprise": { readonly parameters: { readonly query?: { @@ -86697,6 +87715,10 @@ export interface operations { readonly after?: components["parameters"]["pagination-after"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ readonly validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + readonly is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + readonly is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; readonly header?: never; readonly path: { @@ -86721,6 +87743,44 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "copilot/copilot-metrics-for-enterprise-team": { + readonly parameters: { + readonly query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + readonly since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + readonly until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: number; + }; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the enterprise team name. */ + readonly team_slug: components["parameters"]["enterprise-team-slug"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["usage_metrics_api_disabled"]; + readonly 500: components["responses"]["internal_error"]; + }; + }; readonly "copilot/usage-metrics-for-enterprise-team": { readonly parameters: { readonly query?: { @@ -88302,7 +89362,7 @@ export interface operations { readonly members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ readonly members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -88335,7 +89395,7 @@ export interface operations { readonly blog?: string; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88346,7 +89406,7 @@ export interface operations { readonly advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * @@ -88357,7 +89417,7 @@ export interface operations { readonly dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * @@ -88368,7 +89428,7 @@ export interface operations { readonly dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88379,7 +89439,7 @@ export interface operations { readonly dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88390,7 +89450,7 @@ export interface operations { readonly secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88403,6 +89463,8 @@ export interface operations { readonly secret_scanning_push_protection_custom_link_enabled?: boolean; /** @description If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. */ readonly secret_scanning_push_protection_custom_link?: string; + /** @description Controls whether or not deploy keys may be added and used for repositories in the organization. */ + readonly deploy_keys_enabled_for_repositories?: boolean; }; }; }; @@ -88788,6 +89850,415 @@ export interface operations { }; }; }; + readonly "actions/list-self-hosted-runner-groups-for-org": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description Only return runner groups that are allowed to be used by this repository. */ + readonly visible_to_repository?: components["parameters"]["visible-to-repository"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly runner_groups: readonly components["schemas"]["runner-groups-org"][]; + }; + }; + }; + }; + }; + readonly "actions/create-self-hosted-runner-group-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Name of the runner group. */ + readonly name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. + * @default all + * @enum {string} + */ + readonly visibility?: "selected" | "all" | "private"; + /** @description List of repository IDs that can access the runner group. */ + readonly selected_repository_ids?: readonly number[]; + /** @description List of runner IDs to add to the runner group. */ + readonly runners?: readonly number[]; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + readonly allows_public_repositories?: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + readonly restricted_to_workflows?: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + readonly selected_workflows?: readonly string[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + readonly "actions/get-self-hosted-runner-group-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + readonly "actions/delete-self-hosted-runner-group-from-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/update-self-hosted-runner-group-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Name of the runner group. */ + readonly name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. + * @enum {string} + */ + readonly visibility?: "selected" | "all" | "private"; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + readonly allows_public_repositories?: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + readonly restricted_to_workflows?: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + readonly selected_workflows?: readonly string[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + readonly "actions/list-repo-access-to-self-hosted-runner-group-in-org": { + readonly parameters: { + readonly query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly repositories: readonly components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + }; + readonly "actions/set-repo-access-to-self-hosted-runner-group-in-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description List of repository IDs that can access the runner group. */ + readonly selected_repository_ids: readonly number[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/add-repo-access-to-self-hosted-runner-group-in-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ + readonly repository_id: components["parameters"]["repository-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ + readonly repository_id: components["parameters"]["repository-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/list-self-hosted-runners-in-group-for-org": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly runners: readonly components["schemas"]["runner"][]; + }; + }; + }; + }; + }; + readonly "actions/set-self-hosted-runners-in-group-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description List of runner IDs to add to the runner group. */ + readonly runners: readonly number[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/add-self-hosted-runner-to-group-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ + readonly runner_id: components["parameters"]["runner-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/remove-self-hosted-runner-from-group-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ + readonly runner_id: components["parameters"]["runner-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; readonly "actions/list-self-hosted-runners-for-org": { readonly parameters: { readonly query?: { @@ -89962,6 +91433,25 @@ export interface operations { * @enum {string} */ readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @default disabled + * @enum {string} + */ + readonly secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + readonly secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + readonly reviewers?: readonly { + /** @description The ID of the team or role selected as a bypass reviewer */ + readonly reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + readonly reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @default disabled @@ -90166,6 +91656,24 @@ export interface operations { * @enum {string} */ readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + readonly secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + readonly secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + readonly reviewers?: readonly { + /** @description The ID of the team or role selected as a bypass reviewer */ + readonly reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + readonly reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @enum {string} @@ -90227,7 +91735,7 @@ export interface operations { * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` * @enum {string} */ - readonly scope: "all" | "public" | "private_or_internal" | "selected"; + readonly scope: "all" | "all_without_configurations" | "public" | "private_or_internal" | "selected"; /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ readonly selected_repository_ids?: readonly number[]; }; @@ -91013,6 +92521,42 @@ export interface operations { readonly 500: components["responses"]["internal_error"]; }; }; + readonly "copilot/copilot-metrics-for-organization": { + readonly parameters: { + readonly query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + readonly since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + readonly until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: number; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["usage_metrics_api_disabled"]; + readonly 500: components["responses"]["internal_error"]; + }; + }; readonly "copilot/usage-metrics-for-org": { readonly parameters: { readonly query?: { @@ -91610,45 +93154,286 @@ export interface operations { readonly 404: components["responses"]["not_found"]; }; }; - readonly "orgs/update-webhook": { + readonly "orgs/update-webhook": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + readonly hook_id: components["parameters"]["hook-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: { + readonly content: { + readonly "application/json": { + /** @description Key/value pairs to provide settings for this webhook. */ + readonly config?: { + readonly url: components["schemas"]["webhook-config-url"]; + readonly content_type?: components["schemas"]["webhook-config-content-type"]; + readonly secret?: components["schemas"]["webhook-config-secret"]; + readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + /** + * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. + * @default [ + * "push" + * ] + */ + readonly events?: readonly string[]; + /** + * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + * @default true + */ + readonly active?: boolean; + /** @example "web" */ + readonly name?: string; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-hook"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/get-webhook-config-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + readonly hook_id: components["parameters"]["hook-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + }; + readonly "orgs/update-webhook-config-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + readonly hook_id: components["parameters"]["hook-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: { + readonly content: { + readonly "application/json": { + readonly url?: components["schemas"]["webhook-config-url"]; + readonly content_type?: components["schemas"]["webhook-config-content-type"]; + readonly secret?: components["schemas"]["webhook-config-secret"]; + readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + }; + readonly "orgs/list-webhook-deliveries": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ + readonly cursor?: components["parameters"]["cursor"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + readonly hook_id: components["parameters"]["hook-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["hook-delivery-item"][]; + }; + }; + readonly 400: components["responses"]["bad_request"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/get-webhook-delivery": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + readonly hook_id: components["parameters"]["hook-id"]; + readonly delivery_id: components["parameters"]["delivery-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["hook-delivery"]; + }; + }; + readonly 400: components["responses"]["bad_request"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/redeliver-webhook-delivery": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + readonly hook_id: components["parameters"]["hook-id"]; + readonly delivery_id: components["parameters"]["delivery-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + readonly 202: components["responses"]["accepted"]; + readonly 400: components["responses"]["bad_request"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/ping-webhook": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + readonly hook_id: components["parameters"]["hook-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "api-insights/get-route-stats-by-actor": { readonly parameters: { - readonly query?: never; + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + readonly direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + readonly sort?: components["parameters"]["api-insights-route-stats-sort"]; + }; readonly header?: never; readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - readonly hook_id: components["parameters"]["hook-id"]; + /** @description The type of the actor */ + readonly actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + readonly actor_id: components["parameters"]["api-insights-actor-id"]; }; readonly cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description Key/value pairs to provide settings for this webhook. */ - readonly config?: { - readonly url: components["schemas"]["webhook-config-url"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - /** - * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. - * @default [ - * "push" - * ] - */ - readonly events?: readonly string[]; - /** - * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - * @default true - */ - readonly active?: boolean; - /** @example "web" */ - readonly name?: string; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["api-insights-route-stats"]; }; }; }; + }; + readonly "api-insights/get-subject-stats": { + readonly parameters: { + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + readonly direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + readonly sort?: components["parameters"]["api-insights-sort"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; readonly responses: { /** @description Response */ readonly 200: { @@ -91656,22 +93441,23 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-hook"]; + readonly "application/json": components["schemas"]["api-insights-subject-stats"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/get-webhook-config-for-org": { + readonly "api-insights/get-summary-stats": { readonly parameters: { - readonly query?: never; + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; readonly header?: never; readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - readonly hook_id: components["parameters"]["hook-id"]; }; readonly cookie?: never; }; @@ -91683,33 +93469,61 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + readonly "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - readonly "orgs/update-webhook-config-for-org": { + readonly "api-insights/get-summary-stats-by-user": { readonly parameters: { - readonly query?: never; + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; readonly header?: never; readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - readonly hook_id: components["parameters"]["hook-id"]; + /** @description The ID of the user to query for stats */ + readonly user_id: components["parameters"]["api-insights-user-id"]; }; readonly cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - readonly url?: components["schemas"]["webhook-config-url"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; + }; + readonly "api-insights/get-summary-stats-by-actor": { + readonly parameters: { + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The type of the actor */ + readonly actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + readonly actor_id: components["parameters"]["api-insights-actor-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; readonly responses: { /** @description Response */ readonly 200: { @@ -91717,26 +93531,25 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + readonly "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - readonly "orgs/list-webhook-deliveries": { + readonly "api-insights/get-time-stats": { readonly parameters: { - readonly query?: { - /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: components["parameters"]["per-page"]; - /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - readonly cursor?: components["parameters"]["cursor"]; - readonly redelivery?: boolean; + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + readonly timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; readonly header?: never; readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - readonly hook_id: components["parameters"]["hook-id"]; }; readonly cookie?: never; }; @@ -91748,23 +93561,27 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["hook-delivery-item"][]; + readonly "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/get-webhook-delivery": { + readonly "api-insights/get-time-stats-by-user": { readonly parameters: { - readonly query?: never; + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + readonly timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; readonly header?: never; readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - readonly hook_id: components["parameters"]["hook-id"]; - readonly delivery_id: components["parameters"]["delivery-id"]; + /** @description The ID of the user to query for stats */ + readonly user_id: components["parameters"]["api-insights-user-id"]; }; readonly cookie?: never; }; @@ -91776,55 +93593,81 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hook-delivery"]; + readonly "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/redeliver-webhook-delivery": { + readonly "api-insights/get-time-stats-by-actor": { readonly parameters: { - readonly query?: never; + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + readonly timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; readonly header?: never; readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - readonly hook_id: components["parameters"]["hook-id"]; - readonly delivery_id: components["parameters"]["delivery-id"]; + /** @description The type of the actor */ + readonly actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + readonly actor_id: components["parameters"]["api-insights-actor-id"]; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; }; }; - readonly "orgs/ping-webhook": { + readonly "api-insights/get-user-stats": { readonly parameters: { - readonly query?: never; + readonly query: { + /** @description The minimum timestamp to query for stats */ + readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + readonly direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + readonly sort?: components["parameters"]["api-insights-sort"]; + }; readonly header?: never; readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - readonly hook_id: components["parameters"]["hook-id"]; + /** @description The ID of the user to query for stats */ + readonly user_id: components["parameters"]["api-insights-user-id"]; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { /** @description Response */ - readonly 204: { + readonly 200: { headers: { readonly [name: string]: unknown; }; - content?: never; + content: { + readonly "application/json": components["schemas"]["api-insights-user-stats"]; + }; }; - readonly 404: components["responses"]["not_found"]; }; }; readonly "apps/get-org-installation": { @@ -93805,7 +95648,7 @@ export interface operations { readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ readonly custom_property_name: components["parameters"]["custom-property-name"]; }; readonly cookie?: never; @@ -93832,7 +95675,7 @@ export interface operations { readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ readonly custom_property_name: components["parameters"]["custom-property-name"]; }; readonly cookie?: never; @@ -93879,7 +95722,7 @@ export interface operations { readonly path: { /** @description The organization name. The name is not case sensitive. */ readonly org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ readonly custom_property_name: components["parameters"]["custom-property-name"]; }; readonly cookie?: never; @@ -94191,7 +96034,7 @@ export interface operations { readonly delete_branch_on_merge?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default?: boolean; @@ -94263,6 +96106,11 @@ export interface operations { readonly per_page?: components["parameters"]["per-page"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ readonly page?: components["parameters"]["page"]; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + readonly targets?: components["parameters"]["ruleset-targets"]; }; readonly header?: never; readonly path: { @@ -94526,6 +96374,10 @@ export interface operations { readonly after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ readonly validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + readonly is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + readonly is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; readonly header?: never; readonly path: { @@ -94726,6 +96578,44 @@ export interface operations { }; }; }; + readonly "copilot/copilot-metrics-for-team": { + readonly parameters: { + readonly query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + readonly since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + readonly until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: number; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + readonly team_slug: components["parameters"]["team-slug"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["usage_metrics_api_disabled"]; + readonly 500: components["responses"]["internal_error"]; + }; + }; readonly "copilot/usage-metrics-for-team": { readonly parameters: { readonly query?: { @@ -94836,7 +96726,7 @@ export interface operations { */ readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -94946,7 +96836,7 @@ export interface operations { */ readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -96957,6 +98847,11 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ readonly status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." */ + readonly secret_scanning_ai_detection?: { + /** @description Can be `enabled` or `disabled`. */ + readonly status?: string; + }; /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ readonly secret_scanning_non_provider_patterns?: { /** @description Can be `enabled` or `disabled`. */ @@ -97017,7 +98912,7 @@ export interface operations { readonly allow_update_branch?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default?: boolean; @@ -99799,7 +101694,7 @@ export interface operations { readonly strict: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ readonly contexts: readonly string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -100268,7 +102163,7 @@ export interface operations { readonly strict?: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ readonly contexts?: readonly string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -100527,12 +102422,12 @@ export interface operations { }; readonly cookie?: never; }; - readonly requestBody?: { + readonly requestBody: { readonly content: { readonly "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ readonly apps: readonly string[]; - } | readonly string[]; + }; }; }; readonly responses: { @@ -100562,12 +102457,12 @@ export interface operations { }; readonly cookie?: never; }; - readonly requestBody?: { + readonly requestBody: { readonly content: { readonly "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ readonly apps: readonly string[]; - } | readonly string[]; + }; }; }; readonly responses: { @@ -100597,12 +102492,12 @@ export interface operations { }; readonly cookie?: never; }; - readonly requestBody?: { + readonly requestBody: { readonly content: { readonly "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ readonly apps: readonly string[]; - } | readonly string[]; + }; }; }; readonly responses: { @@ -100793,12 +102688,12 @@ export interface operations { }; readonly cookie?: never; }; - readonly requestBody?: { + readonly requestBody: { readonly content: { readonly "application/json": { /** @description The username for users */ readonly users: readonly string[]; - } | readonly string[]; + }; }; }; readonly responses: { @@ -100828,12 +102723,12 @@ export interface operations { }; readonly cookie?: never; }; - readonly requestBody?: { + readonly requestBody: { readonly content: { readonly "application/json": { /** @description The username for users */ readonly users: readonly string[]; - } | readonly string[]; + }; }; }; readonly responses: { @@ -100863,12 +102758,12 @@ export interface operations { }; readonly cookie?: never; }; - readonly requestBody?: { + readonly requestBody: { readonly content: { readonly "application/json": { /** @description The username for users */ readonly users: readonly string[]; - } | readonly string[]; + }; }; }; readonly responses: { @@ -101458,8 +103353,14 @@ export interface operations { readonly per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ readonly ref?: components["parameters"]["git-ref"]; + /** @description The number of the pull request for the results you want to list. */ + readonly pr?: components["parameters"]["pr-alias"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; /** @description The property by which to sort the results. */ readonly sort?: "created" | "updated"; /** @description If specified, only code scanning alerts with this state will be returned. */ @@ -101571,6 +103472,8 @@ export interface operations { readonly per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ readonly ref?: components["parameters"]["git-ref"]; + /** @description The number of the pull request for the results you want to list. */ + readonly pr?: components["parameters"]["pr-alias"]; }; readonly header?: never; readonly path: { @@ -101610,6 +103513,8 @@ export interface operations { readonly page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ readonly per_page?: components["parameters"]["per-page"]; + /** @description The number of the pull request for the results you want to list. */ + readonly pr?: components["parameters"]["pr-alias"]; /** @description The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ readonly ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ @@ -101770,6 +103675,34 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "code-scanning/delete-codeql-database": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The language of the CodeQL database. */ + readonly language: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 403: components["responses"]["code_scanning_forbidden_write"]; + readonly 404: components["responses"]["not_found"]; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; readonly "code-scanning/create-variant-analysis": { readonly parameters: { readonly query?: never; @@ -102176,7 +104109,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ readonly location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ readonly geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -103069,7 +105002,7 @@ export interface operations { readonly path?: string; /** @description Line index in the diff to comment on. */ readonly position?: number; - /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ + /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ readonly line?: number; }; }; @@ -103614,7 +105547,7 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** * @deprecated - * @description **Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. + * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. */ readonly page?: number; /** @@ -104325,7 +106258,7 @@ export interface operations { readonly "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ readonly event_type: string; - /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ + /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. */ readonly client_payload?: { readonly [key: string]: unknown; }; @@ -106050,7 +107983,6 @@ export interface operations { readonly per_page?: components["parameters"]["per-page"]; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ readonly cursor?: components["parameters"]["cursor"]; - readonly redelivery?: boolean; }; readonly header?: never; readonly path: { @@ -106740,7 +108672,7 @@ export interface operations { readonly title: string | number; /** @description The contents of the issue. */ readonly body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ + /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ readonly assignee?: string | null; readonly milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ @@ -107125,7 +109057,7 @@ export interface operations { readonly title?: (string | number) | null; /** @description The contents of the issue. */ readonly body?: string | null; - /** @description Username to assign to this issue. **This field is deprecated.** */ + /** @description Username to assign to this issue. **This field is closing down.** */ readonly assignee?: string | null; /** * @description The open or closed state of the issue. @@ -109569,7 +111501,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ readonly location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ readonly geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -109681,7 +111613,7 @@ export interface operations { readonly path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * @description **This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ readonly position?: number; /** @@ -111096,6 +113028,11 @@ export interface operations { readonly page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ readonly includes_parents?: boolean; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + readonly targets?: components["parameters"]["ruleset-targets"]; }; readonly header?: never; readonly path: { @@ -111374,6 +113311,10 @@ export interface operations { readonly after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ readonly validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + readonly is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + readonly is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; readonly header?: never; readonly path: { @@ -112736,12 +114677,12 @@ export interface operations { readonly q: string; /** * @deprecated - * @description **This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) + * @description **This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ readonly sort?: "indexed"; /** * @deprecated - * @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + * @description **This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ readonly order?: "desc" | "asc"; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -113080,7 +115021,7 @@ export interface operations { */ readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -114372,7 +116313,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ readonly location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ readonly geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -114403,7 +116344,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ readonly location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ readonly geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -115232,6 +117173,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; }; }; readonly "users/unfollow": { diff --git a/packages/openapi-typescript/examples/github-api-next.ts b/packages/openapi-typescript/examples/github-api-next.ts index 4c940d413..353a548df 100644 --- a/packages/openapi-typescript/examples/github-api-next.ts +++ b/packages/openapi-typescript/examples/github-api-next.ts @@ -453,7 +453,7 @@ export interface paths { * List accepted assignments for an assignment * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ - get: operations["classroom/list-accepted-assigments-for-an-assignment"]; + get: operations["classroom/list-accepted-assignments-for-an-assignment"]; put?: never; post?: never; delete?: never; @@ -612,13 +612,16 @@ export interface paths { /** * List all Copilot seat assignments for an enterprise * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + * Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. * * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. * * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + * telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + * see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. * @@ -633,6 +636,35 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for an enterprise + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/enterprises/{enterprise}/copilot/usage": { parameters: { query?: never; @@ -643,7 +675,7 @@ export interface paths { /** * Get a summary of Copilot usage for enterprise members * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -653,6 +685,8 @@ export interface paths { * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * + * The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + * * Only owners and billing managers can view Copilot usage metrics for the enterprise. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -718,6 +752,38 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for an enterprise team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-enterprise-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { parameters: { query?: never; @@ -728,7 +794,7 @@ export interface paths { /** * Get a summary of Copilot usage for an enterprise team * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -1609,10 +1675,10 @@ export interface paths { /** * Update an organization * @description > [!WARNING] - * > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * > **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * > [!WARNING] - * > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * * Updates the organization's profile and member privileges. * @@ -1842,6 +1908,180 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List self-hosted runner groups for an organization + * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-self-hosted-runner-groups-for-org"]; + put?: never; + /** + * Create a self-hosted runner group for an organization + * @description Creates a new self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["actions/create-self-hosted-runner-group-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a self-hosted runner group for an organization + * @description Gets a specific self-hosted runner group for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/get-self-hosted-runner-group-for-org"]; + put?: never; + post?: never; + /** + * Delete a self-hosted runner group from an organization + * @description Deletes a self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + options?: never; + head?: never; + /** + * Update a self-hosted runner group for an organization + * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + patch: operations["actions/update-self-hosted-runner-group-for-org"]; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List repository access to a self-hosted runner group in an organization + * @description Lists the repositories with access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; + /** + * Set repository access for a self-hosted runner group in an organization + * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Add repository access to a self-hosted runner group in an organization + * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; + /** + * Remove repository access to a self-hosted runner group in an organization + * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List self-hosted runners in a group for an organization + * @description Lists self-hosted runners that are in a specific organization group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-self-hosted-runners-in-group-for-org"]; + /** + * Set self-hosted runners in a group for an organization + * @description Replaces the list of self-hosted runners that are part of an organization runner group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Add a self-hosted runner to a group for an organization + * @description Adds a self-hosted runner to a runner group configured in an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + post?: never; + /** + * Remove a self-hosted runner from a group for an organization + * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/runners": { parameters: { query?: never; @@ -2912,11 +3152,11 @@ export interface paths { /** * Get Copilot seat information and settings for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Gets information about an organization's Copilot subscription, including seat breakdown * and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." * * Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. * @@ -2941,11 +3181,14 @@ export interface paths { /** * List all Copilot seat assignments for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + * Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. * Only organization owners can view assigned seats. * + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/list-copilot-seats"]; @@ -2969,16 +3212,16 @@ export interface paths { /** * Add teams to the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * * Only organization owners can add Copilot seats for their organization members. * * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * * The response will contain the total number of new seats that were created and existing seats that were refreshed. * @@ -2988,17 +3231,19 @@ export interface paths { /** * Remove teams from the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Cancels the Copilot seat assignment for all members of each team specified. - * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Sets seats for all members of each team specified to "pending cancellation". + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * + * The response will contain the total number of seats set to "pending cancellation". + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; @@ -3019,16 +3264,16 @@ export interface paths { /** * Add users to the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * * Only organization owners can add Copilot seats for their organization members. * * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * * The response will contain the total number of new seats that were created and existing seats that were refreshed. * @@ -3038,17 +3283,19 @@ export interface paths { /** * Remove users from the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Cancels the Copilot seat assignment for each user specified. - * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Sets seats for all users specified to "pending cancellation". + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * + * The response will contain the total number of seats set to "pending cancellation". + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; @@ -3057,6 +3304,38 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for an organization + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + * Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/copilot/usage": { parameters: { query?: never; @@ -3067,7 +3346,7 @@ export interface paths { /** * Get a summary of Copilot usage for organization members * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -3534,6 +3813,186 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get route stats by actor + * @description Get API request count statistics for an actor broken down by route within a specified time frame. + */ + get: operations["api-insights/get-route-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/subject-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get subject stats + * @description Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + */ + get: operations["api-insights/get-subject-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/summary-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get summary stats + * @description Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + */ + get: operations["api-insights/get-summary-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get summary stats by user + * @description Get overall statistics of API requests within the organization for a user. + */ + get: operations["api-insights/get-summary-stats-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get summary stats by actor + * @description Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + */ + get: operations["api-insights/get-summary-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/time-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get time stats + * @description Get the number of API requests and rate-limited requests made within an organization over a specified time period. + */ + get: operations["api-insights/get-time-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/time-stats/users/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get time stats by user + * @description Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + */ + get: operations["api-insights/get-time-stats-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get time stats by actor + * @description Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + */ + get: operations["api-insights/get-time-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/user-stats/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get user stats + * @description Get API usage statistics within an organization for a user broken down by the type of access. + */ + get: operations["api-insights/get-user-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/installation": { parameters: { query?: never; @@ -3831,9 +4290,12 @@ export interface paths { /** * Get Copilot seat assignment details for a user * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + * + * The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * * Only organization owners can view Copilot seat assignment details for members of their organization. * @@ -4272,7 +4734,7 @@ export interface paths { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; put?: never; @@ -4294,7 +4756,7 @@ export interface paths { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; put?: never; @@ -4305,7 +4767,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; options?: never; @@ -4332,7 +4794,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; delete?: never; @@ -4352,7 +4814,7 @@ export interface paths { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; put?: never; @@ -4374,7 +4836,7 @@ export interface paths { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; put?: never; @@ -4385,7 +4847,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; options?: never; @@ -4412,7 +4874,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; delete?: never; @@ -5041,6 +5503,38 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for a team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + * Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/team/{team_slug}/copilot/usage": { parameters: { query?: never; @@ -5051,7 +5545,7 @@ export interface paths { /** * Get a summary of Copilot usage for a team * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -5689,7 +6183,7 @@ export interface paths { * Enable or disable a security feature for an organization * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). * * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -5949,7 +6443,7 @@ export interface paths { * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." * * > [!NOTE] - * > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; put?: never; @@ -8355,7 +8849,7 @@ export interface paths { * and `0` is returned in this field. * * > [!WARNING] - * > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -8482,7 +8976,7 @@ export interface paths { * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-codeql-databases"]; put?: never; @@ -8510,12 +9004,18 @@ export interface paths { * your HTTP client is configured to follow redirects or use the `Location` header * to make a second request to get the redirect URL. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-codeql-database"]; put?: never; post?: never; - delete?: never; + /** + * Delete a CodeQL database + * @description Deletes a CodeQL database for a language in a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + delete: operations["code-scanning/delete-codeql-database"]; options?: never; head?: never; patch?: never; @@ -8894,8 +9394,6 @@ export interface paths { * @description Gets your public key, which you need to encrypt secrets. You need to * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. - * * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/get-repo-public-key"]; @@ -11038,7 +11536,7 @@ export interface paths { * @description View the progress of an import. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -11082,7 +11580,7 @@ export interface paths { * return a status `422 Unprocessable Entity` response. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ put: operations["migrations/start-import"]; post?: never; @@ -11092,7 +11590,7 @@ export interface paths { * @description Stop an import for a repository. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ delete: operations["migrations/cancel-import"]; options?: never; @@ -11108,7 +11606,7 @@ export interface paths { * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/update-import"]; trace?: never; @@ -11128,7 +11626,7 @@ export interface paths { * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-commit-authors"]; put?: never; @@ -11159,7 +11657,7 @@ export interface paths { * new commits to the repository. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/map-commit-author"]; trace?: never; @@ -11177,7 +11675,7 @@ export interface paths { * @description List files larger than 100MB found during the import * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-large-files"]; put?: never; @@ -11211,7 +11709,7 @@ export interface paths { * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/set-lfs-preference"]; trace?: never; @@ -11540,7 +12038,7 @@ export interface paths { head?: never; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12638,7 +13136,7 @@ export interface paths { * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." @@ -12991,6 +13489,7 @@ export interface paths { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ put: operations["pulls/update-branch"]; post?: never; @@ -13885,10 +14384,10 @@ export interface paths { cookie?: never; }; /** - * Deprecated - List tag protection states for a repository + * Closing down - List tag protection states for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. * * This returns the tag protection states of a repository. * @@ -13897,10 +14396,10 @@ export interface paths { get: operations["repos/list-tag-protection"]; put?: never; /** - * Deprecated - Create a tag protection state for a repository + * Closing down - Create a tag protection state for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. * * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13923,10 +14422,10 @@ export interface paths { put?: never; post?: never; /** - * Deprecated - Delete a tag protection state for a repository + * Closing down - Delete a tag protection state for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. * * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -14428,7 +14927,7 @@ export interface paths { * Get a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; put?: never; @@ -14437,7 +14936,7 @@ export interface paths { * Delete a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -14450,7 +14949,7 @@ export interface paths { * Update a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * @@ -14471,7 +14970,7 @@ export interface paths { * List discussions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -14483,7 +14982,7 @@ export interface paths { * Create a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * @@ -14509,7 +15008,7 @@ export interface paths { * Get a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -14522,7 +15021,7 @@ export interface paths { * Delete a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -14535,7 +15034,7 @@ export interface paths { * Update a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -14555,7 +15054,7 @@ export interface paths { * List discussion comments (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -14567,7 +15066,7 @@ export interface paths { * Create a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * @@ -14593,7 +15092,7 @@ export interface paths { * Get a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -14606,7 +15105,7 @@ export interface paths { * Delete a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -14619,7 +15118,7 @@ export interface paths { * Update a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -14639,7 +15138,7 @@ export interface paths { * List reactions for a team discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14651,7 +15150,7 @@ export interface paths { * Create reaction for a team discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14677,7 +15176,7 @@ export interface paths { * List reactions for a team discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14689,7 +15188,7 @@ export interface paths { * Create reaction for a team discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14715,7 +15214,7 @@ export interface paths { * List pending team invitations (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ @@ -14739,7 +15238,7 @@ export interface paths { * List team members (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -14762,7 +15261,7 @@ export interface paths { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * @@ -14772,7 +15271,7 @@ export interface paths { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * @@ -14790,7 +15289,7 @@ export interface paths { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * @@ -14818,7 +15317,7 @@ export interface paths { * Get team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -14834,7 +15333,7 @@ export interface paths { * Add or update team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -14853,7 +15352,7 @@ export interface paths { * Remove team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -14879,7 +15378,7 @@ export interface paths { * List team projects (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -14903,7 +15402,7 @@ export interface paths { * Check team permissions for a project (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -14912,7 +15411,7 @@ export interface paths { * Add or update team project permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -14922,7 +15421,7 @@ export interface paths { * Remove a project from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -14943,7 +15442,7 @@ export interface paths { * List team repositories (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; put?: never; @@ -14965,7 +15464,7 @@ export interface paths { * Check team permissions for a repository (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * * > [!NOTE] * > Repositories inherited through a parent team will also be checked. @@ -14977,7 +15476,7 @@ export interface paths { * Add or update team repository permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -14989,7 +15488,7 @@ export interface paths { * Remove a repository from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -15010,7 +15509,7 @@ export interface paths { * List child teams (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; put?: never; @@ -16068,6 +16567,9 @@ export interface paths { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ get: operations["orgs/list-for-authenticated-user"]; put?: never; @@ -16089,7 +16591,7 @@ export interface paths { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; put?: never; @@ -16111,7 +16613,7 @@ export interface paths { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; put?: never; @@ -16120,7 +16622,7 @@ export interface paths { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; options?: never; @@ -16145,7 +16647,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; delete?: never; @@ -16165,7 +16667,7 @@ export interface paths { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; put?: never; @@ -16187,7 +16689,7 @@ export interface paths { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; put?: never; @@ -16198,7 +16700,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; options?: never; @@ -16223,7 +16725,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; delete?: never; @@ -16652,7 +17154,7 @@ export interface paths { }; /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). * * > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. @@ -16906,7 +17408,7 @@ export interface paths { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; put?: never; @@ -16928,7 +17430,7 @@ export interface paths { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; put?: never; @@ -16939,7 +17441,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; options?: never; @@ -16966,7 +17468,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; delete?: never; @@ -16986,7 +17488,7 @@ export interface paths { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; put?: never; @@ -17008,7 +17510,7 @@ export interface paths { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; put?: never; @@ -17019,7 +17521,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; options?: never; @@ -17046,7 +17548,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; delete?: never; @@ -17970,7 +18472,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * > [!NOTE] - * > Webhook events for Dependabot alerts are currently in beta and subject to change. + * > Webhook events for Dependabot alerts are currently in public preview and subject to change. * @description A Dependabot alert was automatically closed by a Dependabot auto-triage rule. */ post: operations["dependabot-alert/auto-dismissed"]; @@ -17997,7 +18499,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * > [!NOTE] - * > Webhook events for Dependabot alerts are currently in beta and subject to change. + * > Webhook events for Dependabot alerts are currently in public preview and subject to change. * @description A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed. */ post: operations["dependabot-alert/auto-reopened"]; @@ -18024,7 +18526,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * > [!NOTE] - * > Webhook events for Dependabot alerts are currently in beta and subject to change. + * > Webhook events for Dependabot alerts are currently in public preview and subject to change. * @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. */ post: operations["dependabot-alert/created"]; @@ -18051,7 +18553,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * > [!NOTE] - * > Webhook events for Dependabot alerts are currently in beta and subject to change. + * > Webhook events for Dependabot alerts are currently in public preview and subject to change. * @description A Dependabot alert was manually closed. */ post: operations["dependabot-alert/dismissed"]; @@ -18078,7 +18580,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * > [!NOTE] - * > Webhook events for Dependabot alerts are currently in beta and subject to change. + * > Webhook events for Dependabot alerts are currently in public preview and subject to change. * @description A manifest file change removed a vulnerability. */ post: operations["dependabot-alert/fixed"]; @@ -18105,7 +18607,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * > [!NOTE] - * > Webhook events for Dependabot alerts are currently in beta and subject to change. + * > Webhook events for Dependabot alerts are currently in public preview and subject to change. * @description A manifest file change introduced a vulnerable dependency that had previously been fixed. */ post: operations["dependabot-alert/reintroduced"]; @@ -18132,7 +18634,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * > [!NOTE] - * > Webhook events for Dependabot alerts are currently in beta and subject to change. + * > Webhook events for Dependabot alerts are currently in public preview and subject to change. * @description A Dependabot alert was manually reopened. */ post: operations["dependabot-alert/reopened"]; @@ -18348,7 +18850,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A comment on the discussion was marked as the answer. */ post: operations["discussion/answered"]; @@ -18375,7 +18877,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description The category of a discussion was changed. */ post: operations["discussion/category-changed"]; @@ -18402,7 +18904,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A discussion was closed. */ post: operations["discussion/closed"]; @@ -18429,7 +18931,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A comment on a discussion was created. */ post: operations["discussion-comment/created"]; @@ -18456,7 +18958,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A comment on a discussion was deleted. */ post: operations["discussion-comment/deleted"]; @@ -18483,7 +18985,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A comment on a discussion was edited. */ post: operations["discussion-comment/edited"]; @@ -18510,7 +19012,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A discussion was created. */ post: operations["discussion/created"]; @@ -18537,7 +19039,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A discussion was deleted. */ post: operations["discussion/deleted"]; @@ -18564,7 +19066,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description The title or body on a discussion was edited, or the category of the discussion was changed. */ post: operations["discussion/edited"]; @@ -18591,7 +19093,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A label was added to a discussion. */ post: operations["discussion/labeled"]; @@ -18618,7 +19120,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A discussion was locked. */ post: operations["discussion/locked"]; @@ -18645,7 +19147,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A discussion was pinned. */ post: operations["discussion/pinned"]; @@ -18672,7 +19174,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A discussion was reopened. */ post: operations["discussion/reopened"]; @@ -18699,7 +19201,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A discussion was transferred to another repository. */ post: operations["discussion/transferred"]; @@ -18726,7 +19228,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A comment on the discussion was unmarked as the answer. */ post: operations["discussion/unanswered"]; @@ -18753,7 +19255,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A label was removed from a discussion. */ post: operations["discussion/unlabeled"]; @@ -18780,7 +19282,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A discussion was unlocked. */ post: operations["discussion/unlocked"]; @@ -18807,7 +19309,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * * > [!NOTE] - * > Webhook events for GitHub Discussions are currently in beta and subject to change. + * > Webhook events for GitHub Discussions are currently in public preview and subject to change. * @description A discussion was unpinned. */ post: operations["discussion/unpinned"]; @@ -20227,7 +20729,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. * * > [!NOTE] - * > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. * @description A fine-grained personal access token request was approved. */ post: operations["personal-access-token-request/approved"]; @@ -20252,7 +20754,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. * * > [!NOTE] - * > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. * @description A fine-grained personal access token request was cancelled by the requester. */ post: operations["personal-access-token-request/cancelled"]; @@ -20277,7 +20779,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. * * > [!NOTE] - * > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. * @description A fine-grained personal access token request was created. */ post: operations["personal-access-token-request/created"]; @@ -20302,7 +20804,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. * * > [!NOTE] - * > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. * @description A fine-grained personal access token request was denied. */ post: operations["personal-access-token-request/denied"]; @@ -20710,7 +21212,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * * > [!NOTE] - * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description A project in the organization was closed. */ post: operations["projects-v2/closed"]; @@ -20737,7 +21239,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * * > [!NOTE] - * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description A project in the organization was created. */ post: operations["projects-v2/created"]; @@ -20764,7 +21266,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * * > [!NOTE] - * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description A project in the organization was deleted. */ post: operations["projects-v2/deleted"]; @@ -20791,7 +21293,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * * > [!NOTE] - * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description The title, description, or README of a project in the organization was changed. */ post: operations["projects-v2/edited"]; @@ -20818,7 +21320,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * * > [!NOTE] - * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @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)." */ post: operations["projects-v2-item/archived"]; @@ -20845,7 +21347,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * * > [!NOTE] - * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description A draft issue in an organization project was converted to an issue. */ post: operations["projects-v2-item/converted"]; @@ -20872,7 +21374,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * * > [!NOTE] - * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description An item was added to a project in the organization. */ post: operations["projects-v2-item/created"]; @@ -20899,7 +21401,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * * > [!NOTE] - * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description An item was deleted from a project in the organization. */ post: operations["projects-v2-item/deleted"]; @@ -20926,7 +21428,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * * > [!NOTE] - * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @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. */ post: operations["projects-v2-item/edited"]; @@ -20953,7 +21455,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * * > [!NOTE] - * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @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. */ post: operations["projects-v2-item/reordered"]; @@ -20980,7 +21482,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * * > [!NOTE] - * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @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)." */ post: operations["projects-v2-item/restored"]; @@ -21007,7 +21509,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * * > [!NOTE] - * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description A project in the organization was reopened. */ post: operations["projects-v2/reopened"]; @@ -22404,7 +22906,7 @@ export interface webhooks { * This event occurs when there is activity relating to a security vulnerability alert in a repository. * * > [!WARNING] - * > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. + * > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. * @description A repository vulnerability alert was created. */ post: operations["repository-vulnerability-alert/create"]; @@ -22427,7 +22929,7 @@ export interface webhooks { * This event occurs when there is activity relating to a security vulnerability alert in a repository. * * > [!WARNING] - * > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. + * > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. * @description A repository vulnerability alert was dismissed. */ post: operations["repository-vulnerability-alert/dismiss"]; @@ -22450,7 +22952,7 @@ export interface webhooks { * This event occurs when there is activity relating to a security vulnerability alert in a repository. * * > [!WARNING] - * > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. + * > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. * @description A previously dismissed or resolved repository vulnerability alert was reopened. */ post: operations["repository-vulnerability-alert/reopen"]; @@ -22473,7 +22975,7 @@ export interface webhooks { * This event occurs when there is activity relating to a security vulnerability alert in a repository. * * > [!WARNING] - * > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. + * > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. * @description A repository vulnerability alert was marked as resolved. */ post: operations["repository-vulnerability-alert/resolve"]; @@ -22533,6 +23035,30 @@ export interface webhooks { patch?: never; trace?: never; }; + "secret-scanning-alert-publicly-leaked": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + * + * For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + * @description A secret scanning alert was detected in a public repo. + */ + post: operations["secret-scanning-alert/publicly-leaked"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "secret-scanning-alert-reopened": { parameters: { query?: never; @@ -23476,6 +24002,7 @@ export interface components { type: string; site_admin: boolean; starred_at?: string; + user_view_type?: string; }; /** * @description The type of credit the user is receiving. @@ -23979,7 +24506,7 @@ export interface components { */ organization_custom_properties?: "read" | "write" | "admin"; /** - * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. * @enum {string} */ organization_copilot_seat_management?: "write"; @@ -24014,7 +24541,7 @@ export interface components { */ organization_plan?: "read"; /** - * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). + * @description The level of permission to grant the access token to manage organization projects and projects public preview (where available). * @enum {string} */ organization_projects?: "read" | "write" | "admin"; @@ -24312,7 +24839,7 @@ export interface components { allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -24756,7 +25283,7 @@ export interface components { /** Format: uri */ url: string; sync_to_organizations: string; - group_id?: number | null; + group_id?: string | null; /** Format: uri */ html_url: string; members_url: string; @@ -24770,12 +25297,8 @@ export interface components { * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ "copilot-seat-details": { - /** @description The assignee that has been granted access to GitHub Copilot. */ - assignee: { - [key: string]: unknown; - } & components["schemas"]["simple-user"]; - /** @description The organization to which this seat belongs. */ - organization?: (Record | null) & components["schemas"]["organization-simple"]; + assignee: components["schemas"]["simple-user"]; + organization?: null | components["schemas"]["organization-simple"]; /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ assigning_team?: (null | Record) & (components["schemas"]["team"] | components["schemas"]["enterprise-team"]); /** @@ -24800,6 +25323,157 @@ export interface components { * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. */ updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + "copilot-ide-code-completions": ({ + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + }[]; + editors?: ({ + /** @description Name of the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages, for the given editor. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + total_code_suggestions?: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + total_code_acceptances?: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + total_code_lines_suggested?: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + total_code_lines_accepted?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + })[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + "copilot-ide-chat": ({ + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + total_engaged_users?: number; + editors?: { + /** @description Name of the given editor. */ + name?: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + total_engaged_users?: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + total_chats?: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + total_chat_insertion_events?: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + total_chat_copy_events?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in github.com */ + "copilot-dotcom-chat": ({ + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + total_engaged_users?: number; + /** @description List of model metrics for a custom models and the default model. */ + models?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model (if applicable). */ + custom_model_training_date?: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + total_engaged_users?: number; + /** @description Total number of chats initiated by users on github.com. */ + total_chats?: number; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot for pull requests. */ + "copilot-dotcom-pull-requests": ({ + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + total_engaged_users?: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + repositories?: { + /** @description Repository name */ + name?: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + total_pr_summaries_created?: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + total_engaged_users?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_engaged_users?: number; + copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + } & { + [key: string]: unknown; }; /** * Copilot Usage Metrics @@ -25208,6 +25882,10 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; + /** @description Whether the secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + multi_repo?: boolean | null; }; /** * Actor @@ -25491,6 +26169,11 @@ export interface components { language?: string; raw_url?: string; size?: number; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding: string; }; }; public: boolean; @@ -25516,6 +26199,11 @@ export interface components { login: string; /** Format: int64 */ id: number; + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + user_view_type: "public"; node_id: string; /** Format: uri */ avatar_url: string; @@ -25565,8 +26253,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; private_gists?: number; total_private_repos?: number; owned_private_repos?: number; @@ -25668,6 +26354,11 @@ export interface components { size?: number; truncated?: boolean; content?: string; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding: string; } | null; }; public?: boolean; @@ -25858,6 +26549,10 @@ export interface components { /** @enum {string} */ status?: "enabled" | "disabled"; }; + secret_scanning_ai_detection?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; } | null; /** * Minimal Repository @@ -26063,6 +26758,9 @@ export interface components { owned_private_repos?: number; private_gists?: number | null; disk_usage?: number | null; + /** @description The number of collaborators on private repositories. + * + * This field may be null if the number of private repositories is over 50,000. */ collaborators?: number | null; /** Format: email */ billing_email?: string | null; @@ -26087,7 +26785,7 @@ export interface components { web_commit_signoff_required?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * @@ -26096,7 +26794,7 @@ export interface components { advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * @@ -26105,7 +26803,7 @@ export interface components { dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * @@ -26114,7 +26812,7 @@ export interface components { dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * @@ -26123,7 +26821,7 @@ export interface components { dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * @@ -26132,7 +26830,7 @@ export interface components { secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * @@ -26149,6 +26847,8 @@ export interface components { updated_at: string; /** Format: date-time */ archived_at: string | null; + /** @description Controls whether or not deploy keys may be added and used for repositories in the organization. */ + deploy_keys_enabled_for_repositories?: boolean; }; "actions-cache-usage-org-enterprise": { /** @description The count of active caches across all repositories of an enterprise or an organization. */ @@ -26226,6 +26926,31 @@ export interface components { default_workflow_permissions?: components["schemas"]["actions-default-workflow-permissions"]; can_approve_pull_request_reviews?: components["schemas"]["actions-can-approve-pull-request-reviews"]; }; + "runner-groups-org": { + id: number; + name: string; + visibility: string; + default: boolean; + /** @description Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ + selected_repositories_url?: string; + runners_url: string; + hosted_runners_url?: string; + inherited: boolean; + inherited_allows_public_repositories?: boolean; + allows_public_repositories: boolean; + /** + * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. + * @default false + */ + workflow_restrictions_read_only: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + restricted_to_workflows: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + selected_workflows?: string[]; + }; /** * Self hosted runner label * @description A label for a self hosted runner @@ -26375,9 +27100,9 @@ export interface components { "alert-instances-url": string; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} @@ -26484,7 +27209,7 @@ export interface components { * @description The type of the code security configuration. * @enum {string} */ - target_type?: "global" | "organization"; + target_type?: "global" | "organization" | "enterprise"; /** @description A description of the code security configuration */ description?: string; /** @@ -26532,6 +27257,24 @@ export interface components { * @enum {string} */ secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @enum {string} @@ -26780,8 +27523,8 @@ export interface components { inactive_this_cycle?: number; }; /** - * Copilot Business Organization Details - * @description Information about the seat breakdown and policies set for an organization with a Copilot Business subscription. + * Copilot Organization Details + * @description Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription. */ "copilot-organization-details": { seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; @@ -26810,6 +27553,11 @@ export interface components { * @enum {string} */ seat_management_setting: "assign_all" | "assign_selected" | "disabled" | "unconfigured"; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; } & { [key: string]: unknown; }; @@ -26912,6 +27660,87 @@ export interface components { created_at: string; type: string; }; + /** + * Route Stats + * @description API Insights usage route stats for an actor + */ + "api-insights-route-stats": { + /** @description The HTTP method */ + http_method?: string; + /** @description The API path's route template */ + api_route?: string; + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; + /** + * Subject Stats + * @description API Insights usage subject stats for an organization + */ + "api-insights-subject-stats": { + subject_type?: string; + subject_name?: string; + /** Format: int64 */ + subject_id?: number; + total_request_count?: number; + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; + /** + * Summary Stats + * @description API Insights usage summary stats for an organization + */ + "api-insights-summary-stats": { + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count?: number; + }; + /** + * Time Stats + * @description API Insights usage time stats for an organization + */ + "api-insights-time-stats": { + timestamp?: string; + /** Format: int64 */ + total_request_count?: number; + /** Format: int64 */ + rate_limited_request_count?: number; + }[]; + /** + * User Stats + * @description API Insights usage stats for a user + */ + "api-insights-user-stats": { + actor_type?: string; + actor_name?: string; + /** Format: int64 */ + actor_id?: number; + /** Format: int64 */ + integration_id?: number | null; + /** Format: int64 */ + oauth_application_id?: number | null; + total_request_count?: number; + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; /** * @description The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. * @enum {string} @@ -27087,6 +27916,7 @@ export interface components { type: string; site_admin: boolean; starred_at?: string; + user_view_type?: string; }; /** * Package Version @@ -27153,6 +27983,10 @@ export interface components { }; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -27165,7 +27999,7 @@ export interface components { * @description Minimal representation of an organization programmatic access grant for enumerations */ "organization-programmatic-access-grant": { - /** @description Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token. */ + /** @description Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. */ id: number; owner: components["schemas"]["simple-user"]; /** @@ -27189,6 +28023,10 @@ export interface components { }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ access_granted_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -27491,7 +28329,8 @@ export interface components { */ actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. + * @default always * @enum {string} */ bypass_mode: "always" | "pull_request"; @@ -27561,7 +28400,9 @@ export interface components { }; /** * Organization ruleset conditions - * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. + * @description Conditions for an organization ruleset. + * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + * The push rulesets conditions object does not require the `ref_name` property. */ "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -27650,6 +28491,18 @@ export interface components { /** @enum {string} */ type: "required_signatures"; }; + /** + * RequiredReviewerConfiguration + * @description A reviewing team, and file patterns describing which files they must approve changes to. + */ + "repository-rule-params-required-reviewer-configuration": { + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files. */ + file_patterns: string[]; + /** @description Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. */ + minimum_approvals: number; + /** @description Node ID of the team which must review changes to matching files. */ + reviewer_id: string; + }; /** * pull_request * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -27949,7 +28802,7 @@ export interface components { html?: { /** @description The html URL of the ruleset */ href?: string; - }; + } | null; }; conditions?: (null | (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"])) | components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]; rules?: components["schemas"]["repository-rule"][]; @@ -29417,6 +30270,7 @@ export interface components { received_events_url?: string; type?: string; site_admin?: boolean; + user_view_type?: string; }[]; teams: { id?: number; @@ -29461,6 +30315,7 @@ export interface components { received_events_url?: string; type?: string; site_admin?: boolean; + user_view_type?: string; }; name?: string; client_id?: string; @@ -29823,6 +30678,7 @@ export interface components { * @description A suite of checks performed on the code of a given code change */ "check-suite": { + /** Format: int64 */ id: number; node_id: string; head_branch: string | null; @@ -30292,6 +31148,7 @@ export interface components { admin: boolean; }; role_name: string; + user_view_type?: string; }; /** * Repository Invitation @@ -30589,6 +31446,7 @@ export interface components { name: string; path: string; sha: string; + content?: string; /** Format: uri */ url: string; /** Format: uri */ @@ -30602,7 +31460,6 @@ export interface components { size: number; name: string; path: string; - content?: string; sha: string; /** Format: uri */ url: string; @@ -30664,7 +31521,10 @@ export interface components { * @description Content File */ "content-file": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ type: "file"; encoding: string; size: number; @@ -30696,7 +31556,10 @@ export interface components { * @description An object describing a symlink */ "content-symlink": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ type: "symlink"; target: string; size: number; @@ -30725,7 +31588,10 @@ export interface components { * @description An object describing a submodule */ "content-submodule": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ type: "submodule"; /** Format: uri */ submodule_git_url: string; @@ -30854,6 +31720,7 @@ export interface components { contributions: number; email?: string; name?: string; + user_view_type?: string; }; /** @description A Dependabot alert. */ "dependabot-alert": { @@ -30940,6 +31807,8 @@ export interface components { SPDXID: string; /** @description The version of the SPDX specification that this document conforms to. */ spdxVersion: string; + /** @description An optional comment about the SPDX document. */ + comment?: string; creationInfo: { /** @description The date and time the SPDX document was created. */ created: string; @@ -30950,8 +31819,6 @@ export interface components { name: string; /** @description The license under which the SPDX document is licensed. */ dataLicense: string; - /** @description The name of the repository that the SPDX document describes. */ - documentDescribes: string[]; /** @description The namespace for the SPDX document. */ documentNamespace: string; packages: { @@ -30986,6 +31853,14 @@ export interface components { referenceType: string; }[]; }[]; + relationships?: { + /** @description The type of relationship between the two SPDX elements. */ + relationshipType?: string; + /** @description The SPDX identifier of the package that is the source of the relationship. */ + spdxElementId?: string; + /** @description The SPDX identifier of the package that is the target of the relationship. */ + relatedSpdxElement?: string; + }[]; }; }; /** @@ -31092,7 +31967,7 @@ export interface components { environment: string; /** * Format: uri - * @description Deprecated: the URL to associate with this status. + * @description Closing down notice: the URL to associate with this status. * @default */ target_url: string; @@ -32056,9 +32931,9 @@ export interface components { diff_hunk: string; /** @description The relative path of the file to which the comment applies. */ path: string; - /** @description The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. */ + /** @description The line index in the diff to which the comment applies. This field is closing down; use `line` instead. */ position?: number; - /** @description The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. */ + /** @description The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. */ original_position?: number; /** @description The SHA of the commit to which the comment applies. */ commit_id: string; @@ -32213,6 +33088,7 @@ export interface components { read_only: boolean; added_by?: string | null; last_used?: string | null; + enabled?: boolean; }; /** * Language @@ -32517,361 +33393,16 @@ export interface components { head: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: { - key: string; - name: string; - /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; - } | null; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; - web_commit_signoff_required?: boolean; - } | null; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - /** Format: int64 */ - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; base: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: null | components["schemas"]["license-simple"]; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - web_commit_signoff_required?: boolean; - }; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - /** Format: int64 */ - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; _links: { comments: components["schemas"]["link"]; @@ -33155,6 +33686,10 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + multi_repo?: boolean | null; }; /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ "secret-scanning-alert-resolution-comment": string | null; @@ -33953,6 +34488,7 @@ export interface components { company?: string | null; /** Format: date-time */ suspended_at?: string | null; + user_view_type?: string; }; /** * Private User @@ -33962,6 +34498,11 @@ export interface components { login: string; /** Format: int64 */ id: number; + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + user_view_type: "private"; node_id: string; /** Format: uri */ avatar_url: string; @@ -34017,8 +34558,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; business_plus?: boolean; ldap_dn?: string; }; @@ -34773,7 +35312,7 @@ export interface components { allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -34832,41 +35371,6 @@ export interface components { /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; }; - /** - * Simple User - * @description The GitHub user that triggered the event. This property is included in every webhook payload. - */ - "simple-user-webhooks": { - name?: string | null; - email?: string | null; - login: string; - id: number; - node_id: string; - /** Format: uri */ - avatar_url: string; - gravatar_id: string | null; - /** Format: uri */ - url: string; - /** Format: uri */ - html_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - repos_url: string; - events_url: string; - /** Format: uri */ - received_events_url: string; - type: string; - site_admin: boolean; - starred_at?: string; - }; /** * branch protection rule * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. @@ -35000,6 +35504,7 @@ export interface components { /** Format: uri */ url: string; verified: boolean; + enabled?: boolean; }; /** Workflow */ webhooks_workflow: { @@ -35038,6 +35543,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; webhooks_reviewers: { /** User */ @@ -35127,6 +35633,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; webhooks_answer: { /** @@ -35198,6 +35705,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -35243,6 +35751,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; answer_html_url: string | null; /** @@ -35341,6 +35850,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; labels?: components["schemas"]["label"][]; }; @@ -35412,6 +35922,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Label */ @@ -35541,6 +36052,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The changes to the comment. */ @@ -35593,6 +36105,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -35629,6 +36142,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -35716,6 +36230,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -35798,6 +36313,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -35959,6 +36475,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -36007,6 +36524,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36075,6 +36593,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36111,6 +36630,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -36198,6 +36718,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36280,6 +36801,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36441,6 +36963,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** User */ @@ -36479,6 +37002,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Marketplace Purchase */ webhooks_marketplace_purchase: { @@ -36657,6 +37181,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36730,6 +37255,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -36796,6 +37322,10 @@ export interface components { }[] | null; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -36851,6 +37381,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -36907,6 +37438,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ html_url: string; @@ -37090,7 +37622,7 @@ export interface components { */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ use_squash_pr_title_as_default: boolean; @@ -37178,6 +37710,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -37266,6 +37799,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -37489,6 +38023,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -37598,6 +38133,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -37833,6 +38369,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -37942,6 +38479,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -38009,6 +38547,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -38056,6 +38595,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38279,6 +38819,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -38425,6 +38966,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The review that was affected. */ @@ -38498,6 +39040,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; webhooks_nullable_string: string | null; @@ -38604,6 +39147,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -38751,6 +39295,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -38900,6 +39445,10 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + multi_repo?: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { @@ -38960,6 +39509,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; node_id: string; privacy_level: string; @@ -38999,6 +39549,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** User */ sponsorable: { @@ -39036,6 +39587,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Sponsorship Tier @@ -39147,7 +39699,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection configuration enabled event */ "webhook-branch-protection-configuration-enabled": { @@ -39157,7 +39709,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule created event */ "webhook-branch-protection-rule-created": { @@ -39168,7 +39720,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ "webhook-branch-protection-rule-deleted": { @@ -39179,7 +39731,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ "webhook-branch-protection-rule-edited": { @@ -39230,7 +39782,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ "webhook-check-run-completed": { @@ -39240,7 +39792,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event @@ -39258,7 +39810,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event @@ -39281,7 +39833,7 @@ export interface components { /** @description The integrator reference of the action requested by the user. */ identifier?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event @@ -39299,7 +39851,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event @@ -39373,6 +39925,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39550,7 +40103,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite requested event */ "webhook-check-suite-requested": { @@ -39616,6 +40169,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39793,7 +40347,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite rerequested event */ "webhook-check-suite-rerequested": { @@ -39859,6 +40413,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40036,7 +40591,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert appeared_in_branch event */ "webhook-code-scanning-alert-appeared-in-branch": { @@ -40090,6 +40645,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -40162,7 +40718,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ "webhook-code-scanning-alert-closed-by-user": { @@ -40216,6 +40772,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -40295,7 +40852,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ "webhook-code-scanning-alert-created": { @@ -40370,9 +40927,9 @@ export interface components { }; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - state: "open" | "dismissed"; + state: "open" | "dismissed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -40390,7 +40947,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ "webhook-code-scanning-alert-fixed": { @@ -40444,6 +41001,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -40525,7 +41083,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ "webhook-code-scanning-alert-reopened": { @@ -40618,7 +41176,7 @@ export interface components { /** @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. */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ "webhook-code-scanning-alert-reopened-by-user": { @@ -40702,7 +41260,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** commit_comment created event */ "webhook-commit-comment-created": { @@ -40711,7 +41269,7 @@ export interface components { * @enum {string} */ action: "created"; - /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ + /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ comment: { /** * AuthorAssociation @@ -40790,13 +41348,14 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** create event */ "webhook-create": { @@ -40815,7 +41374,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** custom property created event */ "webhook-custom-property-created": { @@ -40825,7 +41384,7 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property deleted event */ "webhook-custom-property-deleted": { @@ -40838,7 +41397,7 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property updated event */ "webhook-custom-property-updated": { @@ -40848,7 +41407,7 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Custom property values updated event */ "webhook-custom-property-values-updated": { @@ -40858,7 +41417,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; repository: components["schemas"]["repository-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description The new custom property values for the repository. */ new_property_values: components["schemas"]["custom-property-value"][]; /** @description The old custom property values for the repository. */ @@ -40877,7 +41436,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-dismissed event */ "webhook-dependabot-alert-auto-dismissed": { @@ -40888,7 +41447,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-reopened event */ "webhook-dependabot-alert-auto-reopened": { @@ -40899,7 +41458,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ "webhook-dependabot-alert-created": { @@ -40910,7 +41469,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ "webhook-dependabot-alert-dismissed": { @@ -40921,7 +41480,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ "webhook-dependabot-alert-fixed": { @@ -40932,7 +41491,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ "webhook-dependabot-alert-reintroduced": { @@ -40943,7 +41502,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ "webhook-dependabot-alert-reopened": { @@ -40954,7 +41513,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ "webhook-deploy-key-created": { @@ -40965,7 +41524,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ "webhook-deploy-key-deleted": { @@ -40976,7 +41535,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deployment created event */ "webhook-deployment-created": { @@ -41024,6 +41583,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -41086,6 +41646,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41182,7 +41743,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run: { @@ -41222,6 +41783,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -41456,6 +42018,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -41483,7 +42046,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; installation?: components["schemas"]["simple-installation"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-deployment-review-approved": { /** @enum {string} */ @@ -41495,7 +42058,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -41546,6 +42109,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -41614,6 +42178,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -41724,6 +42289,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -41780,6 +42346,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -41799,7 +42366,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -41850,6 +42417,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -41917,6 +42485,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -42027,6 +42596,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -42083,6 +42653,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -42139,11 +42710,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @enum {string} */ type?: "User" | "Team"; }[]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { conclusion: null; @@ -42193,6 +42765,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -42260,6 +42833,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -42370,6 +42944,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -42426,6 +43001,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -42512,6 +43088,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -42574,6 +43151,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42705,6 +43283,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ deployment_url: string; @@ -42772,6 +43351,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42865,7 +43445,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run?: { @@ -42905,6 +43485,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -43139,6 +43720,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -43158,7 +43740,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion category changed event */ "webhook-discussion-category-changed": { @@ -43186,7 +43768,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion closed event */ "webhook-discussion-closed": { @@ -43197,7 +43779,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment created event */ "webhook-discussion-comment-created": { @@ -43209,7 +43791,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment deleted event */ "webhook-discussion-comment-deleted": { @@ -43221,7 +43803,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment edited event */ "webhook-discussion-comment-edited": { @@ -43238,7 +43820,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion created event */ "webhook-discussion-created": { @@ -43249,7 +43831,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion deleted event */ "webhook-discussion-deleted": { @@ -43260,7 +43842,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion edited event */ "webhook-discussion-edited": { @@ -43279,7 +43861,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion labeled event */ "webhook-discussion-labeled": { @@ -43291,7 +43873,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ "webhook-discussion-locked": { @@ -43302,7 +43884,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion pinned event */ "webhook-discussion-pinned": { @@ -43313,7 +43895,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion reopened event */ "webhook-discussion-reopened": { @@ -43324,7 +43906,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion transferred event */ "webhook-discussion-transferred": { @@ -43339,7 +43921,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unanswered event */ "webhook-discussion-unanswered": { @@ -43349,7 +43931,7 @@ export interface components { old_answer: components["schemas"]["webhooks_answer"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ "webhook-discussion-unlabeled": { @@ -43361,7 +43943,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ "webhook-discussion-unlocked": { @@ -43372,7 +43954,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unpinned event */ "webhook-discussion-unpinned": { @@ -43383,7 +43965,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * fork event @@ -43579,6 +44161,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -43730,13 +44313,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ "webhook-github-app-authorization-revoked": { /** @enum {string} */ action: "revoked"; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** gollum event */ "webhook-gollum": { @@ -43764,7 +44347,7 @@ export interface components { title: string; }[]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation created event */ "webhook-installation-created": { @@ -43776,7 +44359,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ "webhook-installation-deleted": { @@ -43788,7 +44371,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ "webhook-installation-new-permissions-accepted": { @@ -43800,7 +44383,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ "webhook-installation-repositories-added": { @@ -43824,7 +44407,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ "webhook-installation-repositories-removed": { @@ -43848,7 +44431,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ "webhook-installation-suspend": { @@ -43860,7 +44443,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { @@ -43900,6 +44483,7 @@ export interface components { updated_at?: string; url?: string; website_url?: null; + user_view_type?: string; }; /** @enum {string} */ action: "renamed"; @@ -43915,7 +44499,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; target_type: string; }; /** installation unsuspend event */ @@ -43928,7 +44512,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ "webhook-issue-comment-created": { @@ -44018,6 +44602,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -44062,6 +44647,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -44098,6 +44684,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -44185,6 +44772,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -44267,6 +44855,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -44428,6 +45017,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -44467,6 +45057,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -44545,7 +45136,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ "webhook-issue-comment-deleted": { @@ -44594,6 +45185,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -44630,6 +45222,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -44717,6 +45310,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -44799,6 +45393,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -44960,6 +45555,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -44999,6 +45595,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -45073,11 +45670,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment edited event */ "webhook-issue-comment-edited": { @@ -45127,6 +45725,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -45163,6 +45762,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -45250,6 +45850,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -45332,6 +45933,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -45493,6 +46095,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -45532,6 +46135,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -45610,7 +46214,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues assigned event */ "webhook-issues-assigned": { @@ -45625,7 +46229,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues closed event */ "webhook-issues-closed": { @@ -45676,6 +46280,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -45712,6 +46317,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -45799,6 +46405,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -45881,6 +46488,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -46042,6 +46650,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -46102,11 +46711,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues deleted event */ "webhook-issues-deleted": { @@ -46157,6 +46767,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46280,6 +46891,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -46362,6 +46974,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -46523,11 +47136,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues demilestoned event */ "webhook-issues-demilestoned": { @@ -46701,6 +47315,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -46783,6 +47398,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -46944,12 +47560,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues edited event */ "webhook-issues-edited": { @@ -47011,6 +47628,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47134,6 +47752,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -47216,6 +47835,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -47377,12 +47997,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues labeled event */ "webhook-issues-labeled": { @@ -47433,6 +48054,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47556,6 +48178,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -47638,6 +48261,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -47799,12 +48423,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues locked event */ "webhook-issues-locked": { @@ -47855,6 +48480,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47891,6 +48517,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47979,6 +48606,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -48061,6 +48689,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -48222,11 +48851,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ "webhook-issues-milestoned": { @@ -48400,6 +49030,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -48482,6 +49113,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -48643,12 +49275,13 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues opened event */ "webhook-issues-opened": { @@ -48698,6 +49331,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48734,6 +49368,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48821,6 +49456,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -48903,6 +49539,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -49064,6 +49701,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } | null; /** @@ -49263,6 +49901,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -49358,6 +49997,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -49394,6 +50034,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -49481,6 +50122,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49563,6 +50205,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -49724,11 +50367,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ "webhook-issues-pinned": { @@ -49739,7 +50383,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ "webhook-issues-reopened": { @@ -49913,6 +50557,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49995,6 +50640,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -50156,11 +50802,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ "webhook-issues-transferred": { @@ -50210,6 +50857,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -50246,6 +50894,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -50333,6 +50982,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -50415,6 +51065,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -50576,6 +51227,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -50778,6 +51430,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50833,7 +51486,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ "webhook-issues-unassigned": { @@ -50848,7 +51501,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ "webhook-issues-unlabeled": { @@ -50860,7 +51513,7 @@ export interface components { label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ "webhook-issues-unlocked": { @@ -50911,6 +51564,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -50947,6 +51601,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -51035,6 +51690,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -51117,6 +51773,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -51278,11 +51935,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ "webhook-issues-unpinned": { @@ -51293,7 +51951,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label created event */ "webhook-label-created": { @@ -51304,7 +51962,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ "webhook-label-deleted": { @@ -51315,7 +51973,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label edited event */ "webhook-label-edited": { @@ -51341,7 +51999,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase cancelled event */ "webhook-marketplace-purchase-cancelled": { @@ -51354,7 +52012,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase changed event */ "webhook-marketplace-purchase-changed": { @@ -51393,7 +52051,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change event */ "webhook-marketplace-purchase-pending-change": { @@ -51432,7 +52090,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change_cancelled event */ "webhook-marketplace-purchase-pending-change-cancelled": { @@ -51471,7 +52129,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase purchased event */ "webhook-marketplace-purchase-purchased": { @@ -51484,7 +52142,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member added event */ "webhook-member-added": { @@ -51509,7 +52167,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member edited event */ "webhook-member-edited": { @@ -51531,7 +52189,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member removed event */ "webhook-member-removed": { @@ -51542,7 +52200,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** membership added event */ "webhook-membership-added": { @@ -51594,6 +52252,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -51647,6 +52306,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -51657,7 +52317,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-merge-group-destroyed": { /** @enum {string} */ @@ -51671,7 +52331,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** meta deleted event */ "webhook-meta-deleted": { @@ -51701,7 +52361,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: null | components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ "webhook-milestone-closed": { @@ -51712,7 +52372,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone created event */ "webhook-milestone-created": { @@ -51723,7 +52383,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ "webhook-milestone-deleted": { @@ -51734,7 +52394,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ "webhook-milestone-edited": { @@ -51760,7 +52420,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ "webhook-milestone-opened": { @@ -51771,7 +52431,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block blocked event */ "webhook-org-block-blocked": { @@ -51782,7 +52442,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block unblocked event */ "webhook-org-block-unblocked": { @@ -51793,7 +52453,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization deleted event */ "webhook-organization-deleted": { @@ -51804,7 +52464,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ "webhook-organization-member-added": { @@ -51815,7 +52475,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ "webhook-organization-member-invited": { @@ -51870,6 +52530,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; login: string | null; node_id: string; @@ -51879,7 +52540,7 @@ export interface components { }; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ @@ -51891,7 +52552,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ "webhook-organization-renamed": { @@ -51907,7 +52568,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ "webhook-rubygems-metadata": { @@ -51981,6 +52642,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -52020,6 +52682,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body?: string | Record; body_html?: string; @@ -52148,6 +52811,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -52183,7 +52847,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** package updated event */ "webhook-package-updated": { @@ -52238,6 +52902,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -52277,6 +52942,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string; body_html: string; @@ -52348,6 +53014,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -52384,7 +53051,7 @@ export interface components { updated_at: string; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** page_build event */ "webhook-page-build": { @@ -52432,6 +53099,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; status: string; updated_at: string; @@ -52443,7 +53111,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** personal_access_token_request approved event */ "webhook-personal-access-token-request-approved": { @@ -52452,7 +53120,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request cancelled event */ @@ -52462,7 +53130,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request created event */ @@ -52472,7 +53140,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation?: components["schemas"]["simple-installation"]; }; /** personal_access_token_request denied event */ @@ -52482,7 +53150,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; organization: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; "webhook-ping": { @@ -52529,7 +53197,7 @@ export interface components { hook_id?: number; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ zen?: string; }; @@ -52552,7 +53220,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card created event */ "webhook-project-card-created": { @@ -52563,7 +53231,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ "webhook-project-card-deleted": { @@ -52620,6 +53288,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -52633,7 +53302,7 @@ export interface components { url: string; }; repository?: null | components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ "webhook-project-card-edited": { @@ -52649,7 +53318,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ "webhook-project-card-moved": { @@ -52710,6 +53379,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -52755,7 +53425,7 @@ export interface components { url?: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project closed event */ "webhook-project-closed": { @@ -52766,7 +53436,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_column created event */ "webhook-project-column-created": { @@ -52777,7 +53447,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ "webhook-project-column-deleted": { @@ -52788,7 +53458,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: null | components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ "webhook-project-column-edited": { @@ -52804,7 +53474,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ "webhook-project-column-moved": { @@ -52815,7 +53485,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project created event */ "webhook-project-created": { @@ -52826,7 +53496,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project deleted event */ "webhook-project-deleted": { @@ -52837,7 +53507,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: null | components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project edited event */ "webhook-project-edited": { @@ -52859,7 +53529,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ "webhook-project-reopened": { @@ -52870,7 +53540,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ "webhook-projects-v2-project-closed": { @@ -52879,7 +53549,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ "webhook-projects-v2-project-created": { @@ -52888,7 +53558,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ "webhook-projects-v2-project-deleted": { @@ -52897,7 +53567,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ "webhook-projects-v2-project-edited": { @@ -52924,7 +53594,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ "webhook-projects-v2-item-archived": { @@ -52934,7 +53604,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ "webhook-projects-v2-item-converted": { @@ -52949,7 +53619,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ "webhook-projects-v2-item-created": { @@ -52958,7 +53628,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ "webhook-projects-v2-item-deleted": { @@ -52967,7 +53637,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ "webhook-projects-v2-item-edited": { @@ -52993,7 +53663,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ "webhook-projects-v2-item-reordered": { @@ -53008,7 +53678,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ "webhook-projects-v2-item-restored": { @@ -53018,7 +53688,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ "webhook-projects-v2-project-reopened": { @@ -53027,7 +53697,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Created Event */ "webhook-projects-v2-status-update-created": { @@ -53036,7 +53706,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Deleted Event */ "webhook-projects-v2-status-update-deleted": { @@ -53045,7 +53715,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Edited Event */ "webhook-projects-v2-status-update-edited": { @@ -53078,7 +53748,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** public event */ "webhook-public": { @@ -53086,7 +53756,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request assigned event */ "webhook-pull-request-assigned": { @@ -53180,6 +53850,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -53216,6 +53887,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -53268,6 +53940,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -53491,6 +54164,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53551,7 +54225,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -53600,6 +54274,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -53835,6 +54510,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53895,7 +54571,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -53944,6 +54620,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -54011,6 +54688,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -54058,6 +54736,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -54124,6 +54803,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -54281,10 +54961,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ "webhook-pull-request-auto-merge-disabled": { @@ -54377,6 +55058,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -54465,6 +55147,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -54688,6 +55371,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54748,7 +55432,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -54797,6 +55481,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -55032,6 +55717,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55092,7 +55778,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -55141,6 +55827,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -55208,6 +55895,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -55255,6 +55943,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -55321,6 +56010,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -55478,11 +56168,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ "webhook-pull-request-auto-merge-enabled": { @@ -55575,6 +56266,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -55663,6 +56355,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -55886,6 +56579,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55946,7 +56640,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -55995,6 +56689,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -56227,6 +56922,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56287,7 +56983,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -56336,6 +57032,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -56403,6 +57100,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -56450,6 +57148,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -56516,6 +57215,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -56673,11 +57373,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason?: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ "webhook-pull-request-closed": { @@ -56689,7 +57390,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ "webhook-pull-request-converted-to-draft": { @@ -56701,7 +57402,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ "webhook-pull-request-demilestoned": { @@ -56713,7 +57414,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request dequeued event */ "webhook-pull-request-dequeued": { @@ -56806,6 +57507,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -56894,6 +57596,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -57117,6 +57820,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57177,7 +57881,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -57226,6 +57930,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -57461,6 +58166,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57521,7 +58227,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -57570,6 +58276,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -57637,6 +58344,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -57684,6 +58392,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -57750,6 +58459,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -57907,11 +58617,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - reason: string; + /** @enum {string} */ + reason: "UNKNOWN_REMOVAL_REASON" | "MANUAL" | "MERGE" | "MERGE_CONFLICT" | "CI_FAILURE" | "CI_TIMEOUT" | "ALREADY_MERGED" | "QUEUE_CLEARED" | "ROLL_BACK" | "BRANCH_PROTECTIONS" | "GIT_TREE_INVALID" | "INVALID_MERGE_COMMIT"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request edited event */ "webhook-pull-request-edited": { @@ -57942,7 +58654,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request enqueued event */ "webhook-pull-request-enqueued": { @@ -58035,6 +58747,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -58123,6 +58836,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -58346,6 +59060,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58406,7 +59121,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -58455,6 +59170,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -58690,6 +59406,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58750,7 +59467,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -58799,6 +59516,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -58866,6 +59584,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -58913,6 +59632,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -58979,6 +59699,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -59136,10 +59857,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ "webhook-pull-request-labeled": { @@ -59233,6 +59955,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -59321,6 +60044,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -59544,6 +60268,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59604,7 +60329,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -59653,6 +60378,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -59888,6 +60614,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59948,7 +60675,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -59997,6 +60724,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -60064,6 +60792,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -60111,6 +60840,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -60177,6 +60907,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -60334,10 +61065,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ "webhook-pull-request-locked": { @@ -60430,6 +61162,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -60518,6 +61251,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -60741,6 +61475,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60801,7 +61536,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -60850,6 +61585,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -61085,6 +61821,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61145,7 +61882,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -61194,6 +61931,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -61261,6 +61999,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -61308,6 +62047,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -61374,6 +62114,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -61531,10 +62272,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ "webhook-pull-request-milestoned": { @@ -61546,7 +62288,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ "webhook-pull-request-opened": { @@ -61558,7 +62300,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ "webhook-pull-request-ready-for-review": { @@ -61570,7 +62312,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ "webhook-pull-request-reopened": { @@ -61582,7 +62324,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ "webhook-pull-request-review-comment-created": { @@ -61732,6 +62474,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -61818,6 +62561,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -61906,6 +62650,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -62129,6 +62874,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62189,7 +62935,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -62238,6 +62984,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -62466,6 +63213,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62526,7 +63274,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -62575,6 +63323,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -62646,6 +63395,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -62710,6 +63460,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -62861,10 +63612,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ "webhook-pull-request-review-comment-deleted": { @@ -62955,6 +63707,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -63043,6 +63796,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -63266,6 +64020,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63326,7 +64081,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -63375,6 +64130,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -63603,6 +64359,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63663,7 +64420,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -63712,6 +64469,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -63783,6 +64541,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -63847,6 +64606,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -63998,10 +64758,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ "webhook-pull-request-review-comment-edited": { @@ -64093,6 +64854,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -64129,6 +64891,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -64181,6 +64944,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -64404,6 +65168,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64464,7 +65229,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -64513,6 +65278,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -64741,6 +65507,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64801,7 +65568,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -64850,6 +65617,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -64921,6 +65689,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -64985,6 +65754,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -65134,12 +65904,13 @@ export interface components { subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; + user_view_type?: string; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ "webhook-pull-request-review-dismissed": { @@ -65230,6 +66001,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -65318,6 +66090,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -65541,6 +66314,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65601,7 +66375,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -65650,6 +66424,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -65878,6 +66653,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65938,7 +66714,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -65987,6 +66763,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -66058,6 +66835,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -66122,6 +66900,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -66273,6 +67052,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -66348,9 +67128,10 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ "webhook-pull-request-review-edited": { @@ -66447,6 +67228,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -66535,6 +67317,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -66736,6 +67519,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66821,6 +67605,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -67027,6 +67812,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67112,6 +67898,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -67183,6 +67970,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -67247,6 +68035,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -67398,11 +68187,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ "webhook-pull-request-review-request-removed": { @@ -67496,6 +68286,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -67532,6 +68323,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -67584,6 +68376,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -67807,6 +68600,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67860,7 +68654,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -67909,6 +68703,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -68144,6 +68939,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68204,7 +69000,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -68253,6 +69049,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -68320,6 +69117,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -68367,6 +69165,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -68433,6 +69232,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -68590,6 +69390,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -68629,8 +69430,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ action: "review_request_removed"; @@ -68722,6 +69524,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -68758,6 +69561,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -68810,6 +69614,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -69033,6 +69838,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69093,7 +69899,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -69142,6 +69948,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -69377,6 +70184,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69437,7 +70245,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -69486,6 +70294,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -69553,6 +70362,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -69600,6 +70410,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -69666,6 +70477,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -69823,6 +70635,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -69881,7 +70694,7 @@ export interface components { */ url: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_requested event */ "webhook-pull-request-review-requested": { @@ -69975,6 +70788,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -70011,6 +70825,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -70063,6 +70878,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -70286,6 +71102,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -70346,7 +71163,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -70395,6 +71212,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -70630,6 +71448,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -70690,7 +71509,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -70739,6 +71558,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -70806,6 +71626,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -70853,6 +71674,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -70919,6 +71741,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -71076,6 +71899,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -71115,8 +71939,9 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ action: "review_requested"; @@ -71208,6 +72033,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -71244,6 +72070,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -71296,6 +72123,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -71519,6 +72347,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71579,7 +72408,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -71628,6 +72457,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -71863,6 +72693,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71923,7 +72754,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -71972,6 +72803,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -72039,6 +72871,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -72086,6 +72919,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -72152,6 +72986,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -72309,6 +73144,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -72367,7 +73203,7 @@ export interface components { */ url?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review submitted event */ "webhook-pull-request-review-submitted": { @@ -72458,6 +73294,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -72546,6 +73383,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -72769,6 +73607,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72829,7 +73668,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -72878,6 +73717,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -73106,6 +73946,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73166,7 +74007,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -73215,6 +74056,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -73286,6 +74128,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -73350,6 +74193,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -73501,11 +74345,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ "webhook-pull-request-review-thread-resolved": { @@ -73596,6 +74441,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -73684,6 +74530,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -73890,6 +74737,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73977,6 +74825,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -74188,6 +75037,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -74275,6 +75125,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -74346,6 +75197,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -74410,6 +75262,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -74561,10 +75414,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -74706,6 +75560,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -74800,6 +75655,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -74888,6 +75744,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -75094,6 +75951,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -75181,6 +76039,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -75392,6 +76251,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -75479,6 +76339,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -75550,6 +76411,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -75614,6 +76476,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -75765,10 +76628,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -75910,6 +76774,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -76008,6 +76873,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -76096,6 +76962,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -76319,6 +77186,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -76379,7 +77247,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -76428,6 +77296,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -76656,6 +77525,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -76716,7 +77586,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -76765,6 +77635,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -76832,6 +77703,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -76879,6 +77751,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -76945,6 +77818,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -77102,10 +77976,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ "webhook-pull-request-unassigned": { @@ -77199,6 +78074,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -77287,6 +78163,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -77510,6 +78387,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -77570,7 +78448,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -77619,6 +78497,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -77854,6 +78733,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -77914,7 +78794,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -77963,6 +78843,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -78030,6 +78911,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -78077,6 +78959,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -78143,6 +79026,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -78300,10 +79184,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ "webhook-pull-request-unlabeled": { @@ -78397,6 +79282,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -78485,6 +79371,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -78708,6 +79595,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -78768,7 +79656,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -78817,6 +79705,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -79045,6 +79934,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -79105,7 +79995,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -79154,6 +80044,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -79221,6 +80112,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -79268,6 +80160,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -79334,6 +80227,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -79491,10 +80385,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ "webhook-pull-request-unlocked": { @@ -79587,6 +80482,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -79675,6 +80571,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -79898,6 +80795,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -79958,7 +80856,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -80007,6 +80905,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -80242,6 +81141,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -80302,7 +81202,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -80351,6 +81251,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -80418,6 +81319,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -80465,6 +81367,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -80531,6 +81434,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -80688,10 +81592,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** push event */ "webhook-push": { @@ -81028,6 +81933,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -81077,7 +81983,7 @@ export interface components { /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-registry-package-published": { /** @enum {string} */ @@ -81112,6 +82018,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -81134,6 +82041,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body?: string | Record; body_html?: string; @@ -81243,6 +82151,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; created_at?: string; draft?: boolean; @@ -81273,7 +82182,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-registry-package-updated": { /** @enum {string} */ @@ -81308,6 +82217,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -81330,6 +82240,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body: string; body_html: string; @@ -81382,6 +82293,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; created_at: string; draft: boolean; @@ -81406,7 +82318,7 @@ export interface components { updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release created event */ "webhook-release-created": { @@ -81417,7 +82329,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release deleted event */ "webhook-release-deleted": { @@ -81428,7 +82340,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release edited event */ "webhook-release-edited": { @@ -81453,7 +82365,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ "webhook-release-prereleased": { @@ -81565,6 +82477,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -81613,7 +82526,7 @@ export interface components { zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release published event */ "webhook-release-published": { @@ -81624,7 +82537,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release released event */ "webhook-release-released": { @@ -81635,7 +82548,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ "webhook-release-unpublished": { @@ -81646,7 +82559,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory published event */ "webhook-repository-advisory-published": { @@ -81657,7 +82570,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory reported event */ "webhook-repository-advisory-reported": { @@ -81668,7 +82581,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ "webhook-repository-archived": { @@ -81678,7 +82591,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository created event */ "webhook-repository-created": { @@ -81688,7 +82601,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository deleted event */ "webhook-repository-deleted": { @@ -81698,7 +82611,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { @@ -81713,7 +82626,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository edited event */ "webhook-repository-edited": { @@ -81737,7 +82650,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_import event */ "webhook-repository-import": { @@ -81745,7 +82658,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @enum {string} */ status: "success" | "cancelled" | "failure"; }; @@ -81757,7 +82670,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository publicized event */ "webhook-repository-publicized": { @@ -81767,7 +82680,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository renamed event */ "webhook-repository-renamed": { @@ -81784,7 +82697,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset created event */ "webhook-repository-ruleset-created": { @@ -81795,7 +82708,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset deleted event */ "webhook-repository-ruleset-deleted": { @@ -81806,7 +82719,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset edited event */ "webhook-repository-ruleset-edited": { @@ -81864,7 +82777,7 @@ export interface components { }[]; }; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ "webhook-repository-transferred": { @@ -81935,6 +82848,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; }; @@ -81943,7 +82857,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository unarchived event */ "webhook-repository-unarchived": { @@ -81953,7 +82867,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert create event */ "webhook-repository-vulnerability-alert-create": { @@ -81964,7 +82878,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert dismiss event */ "webhook-repository-vulnerability-alert-dismiss": { @@ -82017,6 +82931,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; external_identifier: string; /** Format: uri */ @@ -82037,7 +82952,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert reopen event */ "webhook-repository-vulnerability-alert-reopen": { @@ -82048,7 +82963,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert resolve event */ "webhook-repository-vulnerability-alert-resolve": { @@ -82120,7 +83035,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** secret_scanning_alert created event */ "webhook-secret-scanning-alert-created": { @@ -82131,7 +83046,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created": { @@ -82142,13 +83057,24 @@ export interface components { location: components["schemas"]["secret-scanning-location"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created-form-encoded": { /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ payload: string; }; + /** secret_scanning_alert publicly leaked event */ + "webhook-secret-scanning-alert-publicly-leaked": { + /** @enum {string} */ + action: "publicly_leaked"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** secret_scanning_alert reopened event */ "webhook-secret-scanning-alert-reopened": { /** @enum {string} */ @@ -82158,7 +83084,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert resolved event */ "webhook-secret-scanning-alert-resolved": { @@ -82169,7 +83095,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert validated event */ "webhook-secret-scanning-alert-validated": { @@ -82180,7 +83106,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ "webhook-security-advisory-published": { @@ -82191,7 +83117,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ "webhook-security-advisory-updated": { @@ -82202,7 +83128,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ "webhook-security-advisory-withdrawn": { @@ -82250,7 +83176,7 @@ export interface components { }[]; withdrawn_at: string; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ "webhook-security-and-analysis": { @@ -82263,7 +83189,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["full-repository"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ "webhook-sponsorship-cancelled": { @@ -82273,7 +83199,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ @@ -82284,7 +83210,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ @@ -82301,7 +83227,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ @@ -82313,7 +83239,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ @@ -82326,7 +83252,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ @@ -82338,7 +83264,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ @@ -82349,7 +83275,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: string | null; }; @@ -82361,7 +83287,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: null; }; @@ -82525,7 +83451,7 @@ export interface components { name: string; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ sha: string; /** @@ -82551,7 +83477,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** parent issue removed event */ "webhook-sub-issues-parent-issue-removed": { @@ -82567,7 +83493,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sub-issue added event */ "webhook-sub-issues-sub-issue-added": { @@ -82583,7 +83509,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sub-issue removed event */ "webhook-sub-issues-sub-issue-removed": { @@ -82599,7 +83525,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** team_add event */ "webhook-team-add": { @@ -82607,7 +83533,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ @@ -82812,6 +83738,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -82859,7 +83786,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ @@ -83064,6 +83991,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -83111,7 +84039,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ @@ -83316,6 +84244,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -83363,7 +84292,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ @@ -83599,6 +84528,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -83646,7 +84576,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ @@ -83851,6 +84781,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -83898,7 +84829,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ @@ -83909,7 +84840,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** workflow_dispatch event */ "webhook-workflow-dispatch": { @@ -83921,7 +84852,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: string; }; /** workflow_job completed event */ @@ -83932,7 +84863,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -84022,7 +84953,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -84120,7 +85051,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -84174,7 +85105,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -84228,7 +85159,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -84268,6 +85199,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -84418,6 +85350,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -84590,6 +85523,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -84658,6 +85592,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -84678,7 +85613,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -85126,7 +86061,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -85166,6 +86101,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -85316,6 +86252,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -85488,6 +86425,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -85556,6 +86494,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -85649,6 +86588,15 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + usage_metrics_api_disabled: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Service unavailable */ service_unavailable: { headers: { @@ -85897,6 +86845,12 @@ export interface components { "secret-scanning-alert-sort": "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ "secret-scanning-alert-validity": string; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + "secret-scanning-alert-publicly-leaked": boolean; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + "secret-scanning-alert-multi-repo": boolean; + /** @description The slug of the enterprise team name. */ + "enterprise-team-slug": string; /** @description The slug of the team name. */ "team-slug": string; /** @description The unique identifier of the gist. */ @@ -85929,6 +86883,10 @@ export interface components { org: string; /** @description The unique identifier of the repository. */ "repository-id": number; + /** @description Only return runner groups that are allowed to be used by this repository. */ + "visible-to-repository": string; + /** @description Unique identifier of the self-hosted runner group. */ + "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ "runner-id": number; /** @description The name of a self-hosted runner's custom label. */ @@ -85949,6 +86907,22 @@ export interface components { "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; + /** @description The type of the actor */ + "api-insights-actor-type": "installations" | "classic_pats" | "fine_grained_pats" | "oauth_apps" | "github_apps_user_to_server"; + /** @description The ID of the actor */ + "api-insights-actor-id": number; + /** @description The minimum timestamp to query for stats */ + "api-insights-min-timestamp": string; + /** @description The maximum timestamp to query for stats */ + "api-insights-max-timestamp": string; + /** @description The property to sort the results by. */ + "api-insights-route-stats-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[]; + /** @description The property to sort the results by. */ + "api-insights-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[]; + /** @description The ID of the user to query for stats */ + "api-insights-user-id": string; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + "api-insights-timestamp-increment": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The name of the codespace. */ @@ -85984,8 +86958,13 @@ export interface components { "personal-access-token-after": string; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ "custom-property-name": string; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + "ruleset-targets": string; /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ @@ -86078,6 +87057,8 @@ export interface components { status: "queued" | "in_progress" | "completed"; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ "git-ref": components["schemas"]["code-scanning-ref"]; + /** @description The number of the pull request for the results you want to list. */ + "pr-alias": number; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -86401,7 +87382,6 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; header?: never; path?: never; @@ -86857,7 +87837,7 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "classroom/list-accepted-assigments-for-an-assignment": { + "classroom/list-accepted-assignments-for-an-assignment": { parameters: { query?: { /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -87091,6 +88071,42 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "copilot/copilot-metrics-for-enterprise": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-enterprise": { parameters: { query?: { @@ -87214,6 +88230,10 @@ export interface operations { after?: components["parameters"]["pagination-after"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; header?: never; path: { @@ -87238,6 +88258,44 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "copilot/copilot-metrics-for-enterprise-team": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the enterprise team name. */ + team_slug: components["parameters"]["enterprise-team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-enterprise-team": { parameters: { query?: { @@ -88790,7 +89848,7 @@ export interface operations { members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -88822,7 +89880,7 @@ export interface operations { blog?: string; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88833,7 +89891,7 @@ export interface operations { advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * @@ -88844,7 +89902,7 @@ export interface operations { dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * @@ -88855,7 +89913,7 @@ export interface operations { dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88866,7 +89924,7 @@ export interface operations { dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88877,7 +89935,7 @@ export interface operations { secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88890,6 +89948,8 @@ export interface operations { secret_scanning_push_protection_custom_link_enabled?: boolean; /** @description If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. */ secret_scanning_push_protection_custom_link?: string; + /** @description Controls whether or not deploy keys may be added and used for repositories in the organization. */ + deploy_keys_enabled_for_repositories?: boolean; }; }; }; @@ -89275,6 +90335,415 @@ export interface operations { }; }; }; + "actions/list-self-hosted-runner-groups-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description Only return runner groups that are allowed to be used by this repository. */ + visible_to_repository?: components["parameters"]["visible-to-repository"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runner_groups: components["schemas"]["runner-groups-org"][]; + }; + }; + }; + }; + }; + "actions/create-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner group. */ + name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. + * @default all + * @enum {string} + */ + visibility?: "selected" | "all" | "private"; + /** @description List of repository IDs that can access the runner group. */ + selected_repository_ids?: number[]; + /** @description List of runner IDs to add to the runner group. */ + runners?: number[]; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + allows_public_repositories?: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + restricted_to_workflows?: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + selected_workflows?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + "actions/get-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + "actions/delete-self-hosted-runner-group-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/update-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner group. */ + name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. + * @enum {string} + */ + visibility?: "selected" | "all" | "private"; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + allows_public_repositories?: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + restricted_to_workflows?: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + selected_workflows?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + "actions/list-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + }; + "actions/set-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of repository IDs that can access the runner group. */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/add-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/list-self-hosted-runners-in-group-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; + }; + }; + }; + }; + }; + "actions/set-self-hosted-runners-in-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of runner IDs to add to the runner group. */ + runners: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/add-self-hosted-runner-to-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/remove-self-hosted-runner-from-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "actions/list-self-hosted-runners-for-org": { parameters: { query?: { @@ -90449,6 +91918,25 @@ export interface operations { * @enum {string} */ secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @default disabled @@ -90653,6 +92141,24 @@ export interface operations { * @enum {string} */ secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @enum {string} @@ -90714,7 +92220,7 @@ export interface operations { * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` * @enum {string} */ - scope: "all" | "public" | "private_or_internal" | "selected"; + scope: "all" | "all_without_configurations" | "public" | "private_or_internal" | "selected"; /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ selected_repository_ids?: number[]; }; @@ -91500,6 +93006,42 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "copilot/copilot-metrics-for-organization": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-org": { parameters: { query?: { @@ -92095,44 +93637,285 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "orgs/update-webhook": { + "orgs/update-webhook": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Key/value pairs to provide settings for this webhook. */ + config?: { + url: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + /** + * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. + * @default [ + * "push" + * ] + */ + events?: string[]; + /** + * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + * @default true + */ + active?: boolean; + name?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-hook"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/get-webhook-config-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + }; + "orgs/update-webhook-config-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + url?: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + }; + "orgs/list-webhook-deliveries": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ + cursor?: components["parameters"]["cursor"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["hook-delivery-item"][]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/get-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["hook-delivery"]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/redeliver-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/ping-webhook": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "api-insights/get-route-stats-by-actor": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: components["parameters"]["api-insights-route-stats-sort"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; + /** @description The type of the actor */ + actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + actor_id: components["parameters"]["api-insights-actor-id"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** @description Key/value pairs to provide settings for this webhook. */ - config?: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - /** - * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. - * @default [ - * "push" - * ] - */ - events?: string[]; - /** - * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - * @default true - */ - active?: boolean; - name?: string; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["api-insights-route-stats"]; }; }; }; + }; + "api-insights/get-subject-stats": { + parameters: { + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: components["parameters"]["api-insights-sort"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -92140,22 +93923,23 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-hook"]; + "application/json": components["schemas"]["api-insights-subject-stats"]; }; }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/get-webhook-config-for-org": { + "api-insights/get-summary-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; }; cookie?: never; }; @@ -92167,33 +93951,61 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - "orgs/update-webhook-config-for-org": { + "api-insights/get-summary-stats-by-user": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; + /** @description The ID of the user to query for stats */ + user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; }; + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; + }; + }; + }; + }; + "api-insights/get-summary-stats-by-actor": { + parameters: { + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The type of the actor */ + actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + actor_id: components["parameters"]["api-insights-actor-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -92201,26 +94013,25 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - "orgs/list-webhook-deliveries": { + "api-insights/get-time-stats": { parameters: { - query?: { - /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: components["parameters"]["per-page"]; - /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; }; cookie?: never; }; @@ -92232,23 +94043,27 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["hook-delivery-item"][]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/get-webhook-delivery": { + "api-insights/get-time-stats-by-user": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; + /** @description The ID of the user to query for stats */ + user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; @@ -92260,55 +94075,81 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["hook-delivery"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/redeliver-webhook-delivery": { + "api-insights/get-time-stats-by-actor": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; + /** @description The type of the actor */ + actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + actor_id: components["parameters"]["api-insights-actor-id"]; }; cookie?: never; }; requestBody?: never; responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; }; }; - "orgs/ping-webhook": { + "api-insights/get-user-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: components["parameters"]["api-insights-sort"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; + /** @description The ID of the user to query for stats */ + user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["api-insights-user-stats"]; + }; }; - 404: components["responses"]["not_found"]; }; }; "apps/get-org-installation": { @@ -94284,7 +96125,7 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; @@ -94311,7 +96152,7 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; @@ -94357,7 +96198,7 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; @@ -94668,7 +96509,7 @@ export interface operations { delete_branch_on_merge?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -94740,6 +96581,11 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + targets?: components["parameters"]["ruleset-targets"]; }; header?: never; path: { @@ -95003,6 +96849,10 @@ export interface operations { after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; header?: never; path: { @@ -95203,6 +97053,44 @@ export interface operations { }; }; }; + "copilot/copilot-metrics-for-team": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-team": { parameters: { query?: { @@ -95313,7 +97201,7 @@ export interface operations { */ notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -95423,7 +97311,7 @@ export interface operations { */ notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -97394,6 +99282,11 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." */ + secret_scanning_ai_detection?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_scanning_non_provider_patterns?: { /** @description Can be `enabled` or `disabled`. */ @@ -97454,7 +99347,7 @@ export interface operations { allow_update_branch?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -100226,7 +102119,7 @@ export interface operations { strict: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -100695,7 +102588,7 @@ export interface operations { strict?: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -100954,12 +102847,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ apps: string[]; - } | string[]; + }; }; }; responses: { @@ -100989,12 +102882,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ apps: string[]; - } | string[]; + }; }; }; responses: { @@ -101024,12 +102917,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ apps: string[]; - } | string[]; + }; }; }; responses: { @@ -101220,12 +103113,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ users: string[]; - } | string[]; + }; }; }; responses: { @@ -101255,12 +103148,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ users: string[]; - } | string[]; + }; }; }; responses: { @@ -101290,12 +103183,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ users: string[]; - } | string[]; + }; }; }; responses: { @@ -101885,8 +103778,14 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["git-ref"]; + /** @description The number of the pull request for the results you want to list. */ + pr?: components["parameters"]["pr-alias"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; /** @description The property by which to sort the results. */ sort?: "created" | "updated"; /** @description If specified, only code scanning alerts with this state will be returned. */ @@ -101998,6 +103897,8 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["git-ref"]; + /** @description The number of the pull request for the results you want to list. */ + pr?: components["parameters"]["pr-alias"]; }; header?: never; path: { @@ -102037,6 +103938,8 @@ export interface operations { page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The number of the pull request for the results you want to list. */ + pr?: components["parameters"]["pr-alias"]; /** @description The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ @@ -102197,6 +104100,34 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "code-scanning/delete-codeql-database": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The language of the CodeQL database. */ + language: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "code-scanning/create-variant-analysis": { parameters: { query?: never; @@ -102602,7 +104533,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -103495,7 +105426,7 @@ export interface operations { path?: string; /** @description Line index in the diff to comment on. */ position?: number; - /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ + /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ line?: number; }; }; @@ -104038,7 +105969,7 @@ export interface operations { direction?: components["parameters"]["direction"]; /** * @deprecated - * @description **Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. + * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. */ page?: number; /** @@ -104749,7 +106680,7 @@ export interface operations { "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ event_type: string; - /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ + /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. */ client_payload?: { [key: string]: unknown; }; @@ -106459,7 +108390,6 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; header?: never; path: { @@ -107145,7 +109075,7 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ + /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ assignee?: string | null; milestone?: null | string | number; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ @@ -107530,7 +109460,7 @@ export interface operations { title?: null | string | number; /** @description The contents of the issue. */ body?: string | null; - /** @description Username to assign to this issue. **This field is deprecated.** */ + /** @description Username to assign to this issue. **This field is closing down.** */ assignee?: string | null; /** * @description The open or closed state of the issue. @@ -109971,7 +111901,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -110083,7 +112013,7 @@ export interface operations { path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * @description **This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ position?: number; /** @@ -111487,6 +113417,11 @@ export interface operations { page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + targets?: components["parameters"]["ruleset-targets"]; }; header?: never; path: { @@ -111765,6 +113700,10 @@ export interface operations { after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; header?: never; path: { @@ -113127,12 +115066,12 @@ export interface operations { q: string; /** * @deprecated - * @description **This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) + * @description **This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "indexed"; /** * @deprecated - * @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + * @description **This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -113471,7 +115410,7 @@ export interface operations { */ notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -114745,7 +116684,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -114776,7 +116715,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -115602,6 +117541,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; "users/unfollow": { @@ -126505,6 +128445,43 @@ export interface operations { }; }; }; + "secret-scanning-alert/publicly-leaked": { + parameters: { + query?: never; + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example issues */ + "X-Github-Event"?: string; + /** @example 123123 */ + "X-Github-Hook-Installation-Target-Id"?: string; + /** @example repository */ + "X-Github-Hook-Installation-Target-Type"?: string; + /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ + "X-GitHub-Delivery"?: string; + /** @example sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e */ + "X-Hub-Signature-256"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-secret-scanning-alert-publicly-leaked"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "secret-scanning-alert/reopened": { parameters: { query?: never; diff --git a/packages/openapi-typescript/examples/github-api-next.yaml b/packages/openapi-typescript/examples/github-api-next.yaml index 55f2f4d26..dce3ddc78 100644 --- a/packages/openapi-typescript/examples/github-api-next.yaml +++ b/packages/openapi-typescript/examples/github-api-next.yaml @@ -91,6 +91,8 @@ tags: description: Endpoints to manage GitHub Enterprise Teams. - name: code-security description: Endpoints to manage Code security using the REST API. +- name: private-registries + description: Manage private registry configurations. servers: - url: https://api.github.com externalDocs: @@ -503,11 +505,6 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/cursor" - - name: redelivery - in: query - required: false - schema: - type: boolean responses: '200': description: Response @@ -1194,7 +1191,7 @@ paths: the assignment. tags: - classroom - operationId: classroom/list-accepted-assigments-for-an-assignment + operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment @@ -1443,13 +1440,16 @@ paths: summary: List all Copilot seat assignments for an enterprise description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. @@ -1506,12 +1506,83 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/enterprises/{enterprise}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - name: since + description: Show usage metrics since this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). For + more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/copilot/usage": get: summary: Get a summary of Copilot usage for enterprise members description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -1521,6 +1592,8 @@ paths: and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE. + The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + Only owners and billing managers can view Copilot usage metrics for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -1666,6 +1739,8 @@ paths: - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/secret-scanning-alert-validity" + - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" + - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" responses: '200': description: Response @@ -1690,12 +1765,87 @@ paths: enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + > [!NOTE] + > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team-slug" + - name: since + description: Show usage metrics since this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). For + more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for an enterprise team description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -3928,10 +4078,10 @@ paths: summary: Update an organization description: |- > [!WARNING] - > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + > **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). > [!WARNING] - > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). Updates the organization's profile and member privileges. @@ -4026,7 +4176,7 @@ paths: description: "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** - This parameter is deprecated and will be removed in the future. + This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description @@ -4068,7 +4218,7 @@ paths: advanced_security_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. @@ -4079,7 +4229,7 @@ paths: dependabot_alerts_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. @@ -4090,7 +4240,7 @@ paths: dependabot_security_updates_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. @@ -4101,7 +4251,7 @@ paths: dependency_graph_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. @@ -4112,7 +4262,7 @@ paths: secret_scanning_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. @@ -4123,7 +4273,7 @@ paths: secret_scanning_push_protection_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. @@ -4140,6 +4290,10 @@ paths: description: If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. + deploy_keys_enabled_for_repositories: + type: boolean + description: Controls whether or not deploy keys may be added and + used for repositories in the organization. examples: default: value: @@ -4688,6 +4842,546 @@ paths: enabledForGitHubApps: true category: actions subcategory: permissions + "/orgs/{org}/actions/runner-groups": + get: + summary: List self-hosted runner groups for an organization + description: |- + Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/list-self-hosted-runner-groups-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/visible-to-repository" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runner_groups + properties: + total_count: + type: number + runner_groups: + type: array + items: + "$ref": "#/components/schemas/runner-groups-org" + examples: + default: + "$ref": "#/components/examples/runner-groups-org" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + post: + summary: Create a self-hosted runner group for an organization + description: |- + Creates a new self-hosted runner group for an organization. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/create-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner group. + type: string + visibility: + description: Visibility of a runner group. You can select all repositories, + select individual repositories, or limit access to private repositories. + type: string + enum: + - selected + - all + - private + default: all + selected_repository_ids: + description: List of repository IDs that can access the runner group. + type: array + items: + type: integer + description: Unique identifier of the repository. + runners: + description: List of runner IDs to add to the runner group. + type: array + items: + type: integer + description: Unique identifier of the runner. + allows_public_repositories: + description: Whether the runner group can be used by `public` repositories. + type: boolean + default: false + restricted_to_workflows: + description: If `true`, the runner group will be restricted to running + only the workflows specified in the `selected_workflows` array. + type: boolean + default: false + selected_workflows: + description: List of workflows the runner group should be allowed + to run. This setting will be ignored unless `restricted_to_workflows` + is set to `true`. + type: array + items: + type: string + description: Name of workflow the runner group should be allowed + to run. Note that a ref, tag, or long SHA is required. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - name + examples: + default: + value: + name: Expensive hardware runners + visibility: selected + selected_repository_ids: + - 32 + - 91 + runners: + - 9 + - 2 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/runner-groups-org" + examples: + default: + "$ref": "#/components/examples/runner-group" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}": + get: + summary: Get a self-hosted runner group for an organization + description: |- + Gets a specific self-hosted runner group for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/get-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/runner-groups-org" + examples: + default: + "$ref": "#/components/examples/runner-group-item" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + patch: + summary: Update a self-hosted runner group for an organization + description: |- + Updates the `name` and `visibility` of a self-hosted runner group in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/update-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner group. + type: string + visibility: + description: Visibility of a runner group. You can select all repositories, + select individual repositories, or all private repositories. + type: string + enum: + - selected + - all + - private + allows_public_repositories: + description: Whether the runner group can be used by `public` repositories. + type: boolean + default: false + restricted_to_workflows: + description: If `true`, the runner group will be restricted to running + only the workflows specified in the `selected_workflows` array. + type: boolean + default: false + selected_workflows: + description: List of workflows the runner group should be allowed + to run. This setting will be ignored unless `restricted_to_workflows` + is set to `true`. + type: array + items: + type: string + description: Name of workflow the runner group should be allowed + to run. Note that a ref, tag, or long SHA is required. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - name + examples: + default: + value: + name: Expensive hardware runners + visibility: selected + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/runner-groups-org" + examples: + default: + "$ref": "#/components/examples/runner-group" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Delete a self-hosted runner group from an organization + description: |- + Deletes a self-hosted runner group for an organization. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/delete-self-hosted-runner-group-from-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": + get: + summary: List repository access to a self-hosted runner group in an organization + description: |- + Lists the repositories with access to a self-hosted runner group configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/list-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: number + repositories: + type: array + items: + "$ref": "#/components/schemas/minimal-repository" + examples: + default: + "$ref": "#/components/examples/minimal-repository-paginated" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + put: + summary: Set repository access for a self-hosted runner group in an organization + description: |- + Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + description: List of repository IDs that can access the runner group. + type: array + items: + type: integer + description: Unique identifier of the repository. + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 32 + - 91 + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": + put: + summary: Add repository access to a self-hosted runner group in an organization + description: |- + Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/add-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Remove repository access to a self-hosted runner group in an organization + description: |- + Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/remove-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": + get: + summary: List self-hosted runners in a group for an organization + description: |- + Lists self-hosted runners that are in a specific organization group. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/list-self-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: number + runners: + type: array + items: + "$ref": "#/components/schemas/runner" + examples: + default: + "$ref": "#/components/examples/runner-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + put: + summary: Set self-hosted runners in a group for an organization + description: |- + Replaces the list of self-hosted runners that are part of an organization runner group. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-self-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + runners: + description: List of runner IDs to add to the runner group. + type: array + items: + type: integer + description: Unique identifier of the runner. + required: + - runners + examples: + default: + value: + runners: + - 9 + - 2 + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": + put: + summary: Add a self-hosted runner to a group for an organization + description: |- + Adds a self-hosted runner to a runner group configured in an organization. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/add-self-hosted-runner-to-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/runner-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Remove a self-hosted runner from a group for an organization + description: |- + Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/remove-self-hosted-runner-from-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/runner-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups "/orgs/{org}/actions/runners": get: summary: List self-hosted runners for an organization @@ -6377,6 +7071,39 @@ paths: - disabled - not_set default: disabled + secret_scanning_delegated_bypass: + type: string + description: The enablement status of secret scanning delegated + bypass + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_bypass_options: + type: object + description: Feature options for secret scanning delegated bypass + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated + bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a + bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE secret_scanning_validity_checks: type: string description: The enablement status of secret scanning validity checks @@ -6665,6 +7392,38 @@ paths: - enabled - disabled - not_set + secret_scanning_delegated_bypass: + type: string + description: The enablement status of secret scanning delegated + bypass + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass_options: + type: object + description: Feature options for secret scanning delegated bypass + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated + bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a + bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE secret_scanning_validity_checks: type: string description: The enablement status of secret scanning validity checks @@ -6787,6 +7546,7 @@ paths: the repositories specified by `selected_repository_ids` enum: - all + - all_without_configurations - public - private_or_internal - selected @@ -7586,11 +8346,11 @@ paths: summary: Get Copilot seat information and settings for an organization description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. @@ -7633,11 +8393,14 @@ paths: summary: List all Copilot seat assignments for an organization description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. Only organization owners can view assigned seats. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot @@ -7695,16 +8458,16 @@ paths: summary: Add teams to the Copilot subscription for an organization description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for all users within each specified team. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -7747,7 +8510,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for members of the + specified team(s). properties: seats_created: type: integer @@ -7779,17 +8543,19 @@ paths: summary: Remove teams from the Copilot subscription for an organization description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for all members of each team specified. - This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all members of each team specified to "pending cancellation". + This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -7829,7 +8595,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for members of the specified team(s). properties: seats_cancelled: type: integer @@ -7862,16 +8629,16 @@ paths: summary: Add users to the Copilot subscription for an organization description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for each user specified. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -7914,7 +8681,7 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for the specified user(s). properties: seats_created: type: integer @@ -7946,17 +8713,19 @@ paths: summary: Remove users from the Copilot subscription for an organization description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for each user specified. - This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all users specified to "pending cancellation". + This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -7996,7 +8765,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for the specified users. properties: seats_cancelled: type: integer @@ -8025,12 +8795,86 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/orgs/{org}/copilot/metrics": + get: + summary: Get Copilot metrics for an organization + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - name: since + description: Show usage metrics since this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). For + more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/copilot/usage": get: summary: Get a summary of Copilot usage for organization members description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -9035,11 +9879,6 @@ paths: - "$ref": "#/components/parameters/hook-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/cursor" - - name: redelivery - in: query - required: false - schema: - type: boolean responses: '200': description: Response @@ -9162,6 +10001,292 @@ paths: enabledForGitHubApps: true category: orgs subcategory: webhooks + "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": + get: + summary: Get route stats by actor + description: Get API request count statistics for an actor broken down by route + within a specified time frame. + tags: + - orgs + operationId: api-insights/get-route-stats-by-actor + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-actor-type" + - "$ref": "#/components/parameters/api-insights-actor-id" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/api-insights-route-stats-sort" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-route-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-route-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/subject-stats": + get: + summary: Get subject stats + description: Get API request statistics for all subjects within an organization + within a specified time frame. Subjects can be users or GitHub Apps. + tags: + - orgs + operationId: api-insights/get-subject-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/api-insights-sort" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-subject-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-subject-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/summary-stats": + get: + summary: Get summary stats + description: Get overall statistics of API requests made within an organization + by all users and apps within a specified time frame. + tags: + - orgs + operationId: api-insights/get-summary-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-summary-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-summary-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/summary-stats/users/{user_id}": + get: + summary: Get summary stats by user + description: Get overall statistics of API requests within the organization + for a user. + tags: + - orgs + operationId: api-insights/get-summary-stats-by-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-user-id" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-summary-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-summary-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": + get: + summary: Get summary stats by actor + description: Get overall statistics of API requests within the organization + made by a specific actor. Actors can be GitHub App installations, OAuth apps + or other tokens on behalf of a user. + tags: + - orgs + operationId: api-insights/get-summary-stats-by-actor + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + - "$ref": "#/components/parameters/api-insights-actor-type" + - "$ref": "#/components/parameters/api-insights-actor-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-summary-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-summary-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/time-stats": + get: + summary: Get time stats + description: Get the number of API requests and rate-limited requests made within + an organization over a specified time period. + tags: + - orgs + operationId: api-insights/get-time-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-time-stats + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + - "$ref": "#/components/parameters/api-insights-timestamp-increment" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-time-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-time-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/time-stats/users/{user_id}": + get: + summary: Get time stats by user + description: Get the number of API requests and rate-limited requests made within + an organization by a specific user over a specified time period. + tags: + - orgs + operationId: api-insights/get-time-stats-by-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-user-id" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + - "$ref": "#/components/parameters/api-insights-timestamp-increment" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-time-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-time-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": + get: + summary: Get time stats by actor + description: Get the number of API requests and rate-limited requests made within + an organization by a specific actor within a specified time period. + tags: + - orgs + operationId: api-insights/get-time-stats-by-actor + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-actor-type" + - "$ref": "#/components/parameters/api-insights-actor-id" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + - "$ref": "#/components/parameters/api-insights-timestamp-increment" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-time-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-time-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/user-stats/{user_id}": + get: + summary: Get user stats + description: Get API usage statistics within an organization for a user broken + down by the type of access. + tags: + - orgs + operationId: api-insights/get-user-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-user-stats + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-user-id" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/api-insights-sort" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-user-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-user-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights "/orgs/{org}/installation": get: summary: Get an organization installation for the authenticated app @@ -9892,9 +11017,12 @@ paths: summary: Get Copilot seat assignment details for a user description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. - Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + + The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only organization owners can view Copilot seat assignment details for members of their organization. @@ -10882,7 +12010,7 @@ paths: description: |- Lists packages in an organization readable by the user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-organization @@ -10952,7 +12080,7 @@ paths: description: |- Gets a specific package in an organization. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-organization @@ -10985,7 +12113,7 @@ paths: The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-org @@ -11022,7 +12150,7 @@ paths: The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-org @@ -11059,7 +12187,7 @@ paths: description: |- Lists package versions for a package owned by an organization. - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-org @@ -11111,7 +12239,7 @@ paths: description: |- Gets a specific package version in an organization. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-organization @@ -11145,7 +12273,7 @@ paths: The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-org @@ -11183,7 +12311,7 @@ paths: The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-org @@ -12457,7 +13585,7 @@ paths: type: boolean description: Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property - has been deprecated. Please use `squash_merge_commit_title` instead. + is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true squash_merge_commit_title: @@ -12569,6 +13697,7 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/ruleset-targets" responses: '200': description: Response @@ -12948,6 +14077,8 @@ paths: - "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo" - "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" - "$ref": "#/components/parameters/secret-scanning-alert-validity" + - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" + - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" responses: '200': description: Response @@ -13230,12 +14361,87 @@ paths: enabledForGitHubApps: false category: billing subcategory: billing + "/orgs/{org}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for a team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - name: since + description: Show usage metrics since this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). For + more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for a team description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -13407,7 +14613,7 @@ paths: - notifications_disabled permission: type: string - description: "**Deprecated**. The permission that new repositories + description: "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified." enum: - pull @@ -13533,7 +14739,7 @@ paths: - notifications_disabled permission: type: string - description: "**Deprecated**. The permission that new repositories + description: "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified." enum: - pull @@ -14962,7 +16168,7 @@ paths: summary: Enable or disable a security feature for an organization description: |- > [!WARNING] - > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." @@ -16063,7 +17269,7 @@ paths: * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." > [!NOTE] - > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. tags: - rate-limit operationId: rate-limit/get @@ -16221,6 +17427,16 @@ paths: status: type: string description: Can be `enabled` or `disabled`. + secret_scanning_ai_detection: + type: object + description: Use the `status` property to enable or disable + secret scanning AI detection for this repository. For more + information, see "[Responsible detection of generic secrets + with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." + properties: + status: + type: string + description: Can be `enabled` or `disabled`. secret_scanning_non_provider_patterns: type: object description: Use the `status` property to enable or disable @@ -16293,7 +17509,7 @@ paths: type: boolean description: Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property - has been deprecated. Please use `squash_merge_commit_title` instead. + is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true squash_merge_commit_title: @@ -20026,12 +21242,12 @@ paths: contexts: type: array deprecated: true - description: "**Deprecated**: The list of status checks to require - in order to merge into this branch. If any of these checks - have recently been set by a particular GitHub App, they will - be required to come from that app in future for the branch - to merge. Use `checks` instead of `contexts` for more fine-grained - control." + description: "**Closing down notice**: The list of status checks + to require in order to merge into this branch. If any of these + checks have recently been set by a particular GitHub App, + they will be required to come from that app in future for + the branch to merge. Use `checks` instead of `contexts` for + more fine-grained control." items: type: string checks: @@ -20738,11 +21954,12 @@ paths: contexts: type: array deprecated: true - description: "**Deprecated**: The list of status checks to require - in order to merge into this branch. If any of these checks have - recently been set by a particular GitHub App, they will be required - to come from that app in future for the branch to merge. Use `checks` - instead of `contexts` for more fine-grained control." + description: "**Closing down notice**: The list of status checks + to require in order to merge into this branch. If any of these + checks have recently been set by a particular GitHub App, they + will be required to come from that app in future for the branch + to merge. Use `checks` instead of `contexts` for more fine-grained + control." items: type: string checks: @@ -21173,28 +22390,24 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: - required: false + required: true content: application/json: schema: - oneOf: - - type: object - properties: - apps: - type: array - description: 'The GitHub Apps that have push access to this branch. - Use the slugified version of the app name. **Note**: The list - of users, apps, and teams in total is limited to 100 items.' - items: - type: string - required: - - apps - example: - apps: - - my-app - - type: array - items: - type: string + type: object + properties: + apps: + type: array + description: 'The GitHub Apps that have push access to this branch. + Use the slugified version of the app name. **Note**: The list + of users, apps, and teams in total is limited to 100 items.' + items: + type: string + required: + - apps + example: + apps: + - my-app examples: default: value: @@ -21237,28 +22450,24 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: - required: false + required: true content: application/json: schema: - oneOf: - - type: object - properties: - apps: - type: array - description: 'The GitHub Apps that have push access to this branch. - Use the slugified version of the app name. **Note**: The list - of users, apps, and teams in total is limited to 100 items.' - items: - type: string - required: - - apps - example: - apps: - - my-app - - type: array - items: - type: string + type: object + properties: + apps: + type: array + description: 'The GitHub Apps that have push access to this branch. + Use the slugified version of the app name. **Note**: The list + of users, apps, and teams in total is limited to 100 items.' + items: + type: string + required: + - apps + example: + apps: + - my-app examples: default: value: @@ -21301,27 +22510,24 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: + required: true content: application/json: schema: - oneOf: - - type: object - properties: - apps: - type: array - description: 'The GitHub Apps that have push access to this branch. - Use the slugified version of the app name. **Note**: The list - of users, apps, and teams in total is limited to 100 items.' - items: - type: string - required: - - apps - example: - apps: - - my-app - - type: array - items: - type: string + type: object + properties: + apps: + type: array + description: 'The GitHub Apps that have push access to this branch. + Use the slugified version of the app name. **Note**: The list + of users, apps, and teams in total is limited to 100 items.' + items: + type: string + required: + - apps + example: + apps: + - my-app examples: default: value: @@ -21631,26 +22837,22 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: - required: false + required: true content: application/json: schema: - oneOf: - - type: object - properties: - users: - type: array - description: The username for users - items: - type: string - required: - - users - example: - users: - - mona - - type: array - items: - type: string + type: object + properties: + users: + type: array + description: The username for users + items: + type: string + required: + - users + example: + users: + - mona examples: default: summary: Example adding a user in a branch protection rule @@ -21698,26 +22900,22 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: - required: false + required: true content: application/json: schema: - oneOf: - - type: object - properties: - users: - type: array - description: The username for users - items: - type: string - required: - - users - example: - users: - - mona - - type: array - items: - type: string + type: object + properties: + users: + type: array + description: The username for users + items: + type: string + required: + - users + example: + users: + - mona examples: default: summary: Example replacing a user in a branch protection rule @@ -21765,25 +22963,22 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: + required: true content: application/json: schema: - oneOf: - - type: object - properties: - users: - type: array - description: The username for users - items: - type: string - required: - - users - example: - users: - - mona - - type: array - items: - type: string + type: object + properties: + users: + type: array + description: The username for users + items: + type: string + required: + - users + example: + users: + - mona examples: default: summary: Example removing a user in a branch protection rule @@ -22096,6 +23291,8 @@ paths: required: - name - head_sha + discriminator: + propertyName: status oneOf: - properties: status: @@ -22845,7 +24042,10 @@ paths: - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/git-ref" + - "$ref": "#/components/parameters/pr-alias" - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" - name: sort description: The property by which to sort the results. in: query @@ -23013,6 +24213,7 @@ paths: - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/git-ref" + - "$ref": "#/components/parameters/pr-alias" responses: '200': description: Response @@ -23052,7 +24253,7 @@ paths: and `0` is returned in this field. > [!WARNING] - > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. operationId: code-scanning/list-recent-analyses @@ -23068,6 +24269,7 @@ paths: - "$ref": "#/components/parameters/tool-guid" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pr-alias" - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` @@ -23304,7 +24506,7 @@ paths: description: |- Lists the CodeQL databases that are available in a repository. - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/list-codeql-databases @@ -23350,7 +24552,7 @@ paths: your HTTP client is configured to follow redirects or use the `Location` header to make a second request to get the redirect URL. - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/get-codeql-database @@ -23390,6 +24592,42 @@ paths: previews: [] category: code-scanning subcategory: code-scanning + delete: + summary: Delete a CodeQL database + description: |- + Deletes a CodeQL database for a language in a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/delete-codeql-database + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: language + in: path + description: The language of the CodeQL database. + schema: + type: string + required: true + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/code_scanning_forbidden_write" + '404': + "$ref": "#/components/responses/not_found" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": post: summary: Create a CodeQL variant analysis @@ -24054,7 +25292,7 @@ paths: geo: description: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, - which is being deprecated. + which is closing down. type: string enum: - EuropeWest @@ -24449,8 +25687,6 @@ paths: Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. - Anyone with read access to the repository can use this endpoint. - If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - codespaces @@ -25404,8 +26640,8 @@ paths: description: Line index in the diff to comment on. line: type: integer - description: "**Deprecated**. Use **position** parameter instead. - Line number in the file to comment on." + description: "**Closing down notice**. Use **position** parameter + instead. Line number in the file to comment on." required: - body examples: @@ -25977,6 +27213,13 @@ paths: - "$ref": "#/components/schemas/content-file" - "$ref": "#/components/schemas/content-symlink" - "$ref": "#/components/schemas/content-submodule" + discriminator: + propertyName: type + mapping: + array: "#/components/schemas/content-directory" + file: "#/components/schemas/content-file" + symlink: "#/components/schemas/content-symlink" + submodule: "#/components/schemas/content-submodule" examples: response-if-content-is-a-file: "$ref": "#/components/examples/content-file-response-if-content-is-a-file" @@ -26316,8 +27559,8 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - name: page - description: "**Deprecated**. Page number of the results to fetch. Use cursor-based - pagination with `before` or `after` instead." + description: "**Closing down notice**. Page number of the results to fetch. + Use cursor-based pagination with `before` or `after` instead." deprecated: true in: query schema: @@ -27342,7 +28585,8 @@ paths: type: object description: JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number - of top-level properties is 10. + of top-level properties is 10. The total size of the JSON payload + must be less than 64KB. additionalProperties: true maxProperties: 10 examples: @@ -29881,11 +31125,6 @@ paths: - "$ref": "#/components/parameters/hook-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/cursor" - - name: redelivery - in: query - required: false - schema: - type: boolean responses: '200': description: Response @@ -30028,7 +31267,7 @@ paths: View the progress of an import. > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). **Import status** @@ -30101,7 +31340,7 @@ paths: return a status `422 Unprocessable Entity` response. > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/start-import @@ -30193,7 +31432,7 @@ paths: You can select the project to import by providing one of the objects in the `project_choices` array in the update request. > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/update-import @@ -30279,7 +31518,7 @@ paths: Stop an import for a repository. > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/cancel-import @@ -30311,7 +31550,7 @@ paths: This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/get-commit-authors @@ -30354,7 +31593,7 @@ paths: new commits to the repository. > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/map-commit-author @@ -30419,7 +31658,7 @@ paths: List files larger than 100MB found during the import > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/get-large-files @@ -30462,7 +31701,7 @@ paths: site](https://docs.github.com/repositories/working-with-files/managing-large-files). > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/set-lfs-preference @@ -30915,7 +32154,7 @@ paths: description: 'Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This - field is deprecated.**_' + field is closing down.**_' milestone: oneOf: - type: string @@ -31456,7 +32695,7 @@ paths: patch: summary: Update an issue description: |- - Issue owners and users with push access can edit an issue. + Issue owners and users with push access or Triage role can edit an issue. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -31499,7 +32738,8 @@ paths: type: - string - 'null' - description: Username to assign to this issue. **This field is deprecated.** + description: Username to assign to this issue. **This field is closing + down.** state: type: string description: The open or closed state of the issue. @@ -34992,7 +36232,7 @@ paths: geo: description: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, - which is being deprecated. + which is closing down. type: string enum: - EuropeWest @@ -35126,7 +36366,7 @@ paths: If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. - The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." @@ -35167,7 +36407,7 @@ paths: description: The relative path to the file that necessitates a comment. position: type: integer - description: '**This parameter is deprecated. Use `line` instead**. + description: '**This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first @@ -36227,8 +37467,9 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": put: summary: Update a pull request branch - description: Updates the pull request branch with the latest upstream changes - by merging HEAD from the base branch into the pull request branch. + description: |- + Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. tags: - pulls operationId: pulls/update-branch @@ -37262,6 +38503,7 @@ paths: schema: type: boolean default: true + - "$ref": "#/components/parameters/ruleset-targets" responses: '200': description: Response @@ -37641,6 +38883,8 @@ paths: - "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo" - "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" - "$ref": "#/components/parameters/secret-scanning-alert-validity" + - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" + - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" responses: '200': description: Response @@ -38829,10 +40073,10 @@ paths: subcategory: repos "/repos/{owner}/{repo}/tags/protection": get: - summary: Deprecated - List tag protection states for a repository + summary: Closing down - List tag protection states for a repository description: |- > [!WARNING] - > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. This returns the tag protection states of a repository. @@ -38842,7 +40086,7 @@ paths: operationId: repos/list-tag-protection externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/tags#deprecated---list-tag-protection-states-for-a-repository + url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -38871,10 +40115,10 @@ paths: removalDate: '2024-08-30' deprecated: true post: - summary: Deprecated - Create a tag protection state for a repository + summary: Closing down - Create a tag protection state for a repository description: |- > [!WARNING] - > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. This creates a tag protection state for a repository. This endpoint is only available to repository administrators. @@ -38883,7 +40127,7 @@ paths: operationId: repos/create-tag-protection externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/tags#deprecated---create-a-tag-protection-state-for-a-repository + url: https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -38928,10 +40172,10 @@ paths: deprecated: true "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": delete: - summary: Deprecated - Delete a tag protection state for a repository + summary: Closing down - Delete a tag protection state for a repository description: |- > [!WARNING] - > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. This deletes a tag protection state for a repository. This endpoint is only available to repository administrators. @@ -38940,7 +40184,7 @@ paths: operationId: repos/delete-tag-protection externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/tags#deprecated---delete-a-tag-protection-state-for-a-repository + url: https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -39602,7 +40846,7 @@ paths: type: string - name: sort deprecated: true - description: "**This field is deprecated.** Sorts the results of your query. + description: "**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)" in: query @@ -39612,9 +40856,10 @@ paths: enum: - indexed - name: order - description: "**This field is deprecated.** Determines whether the first search - result returned is the highest number of matches (`desc`) or lowest number - of matches (`asc`). This parameter is ignored unless you provide `sort`. " + description: "**This field is closing down.** Determines whether the first + search result returned is the highest number of matches (`desc`) or lowest + number of matches (`asc`). This parameter is ignored unless you provide + `sort`. " in: query deprecated: true required: false @@ -40142,7 +41387,7 @@ paths: summary: Get a team (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. tags: - teams operationId: teams/get-legacy @@ -40175,7 +41420,7 @@ paths: summary: Update a team (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. To edit a team, the authenticated user must either be an organization owner or a team maintainer. @@ -40226,7 +41471,7 @@ paths: - notifications_disabled permission: type: string - description: "**Deprecated**. The permission that new repositories + description: "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified." enum: - pull @@ -40284,7 +41529,7 @@ paths: summary: Delete a team (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. To delete a team, the authenticated user must be an organization owner or team maintainer. @@ -40317,7 +41562,7 @@ paths: summary: List discussions (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. List all discussions on a team's page. @@ -40360,7 +41605,7 @@ paths: summary: Create a discussion (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. Creates a new discussion post on a team's page. @@ -40427,7 +41672,7 @@ paths: summary: Get a discussion (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. Get a specific discussion on a team's page. @@ -40463,7 +41708,7 @@ paths: summary: Update a discussion (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. Edits the title and body text of a discussion post. Only the parameters you provide are updated. @@ -40516,7 +41761,7 @@ paths: summary: Delete a discussion (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. Delete a discussion from a team's page. @@ -40546,7 +41791,7 @@ paths: summary: List discussion comments (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. List all comments on a team discussion. @@ -40590,7 +41835,7 @@ paths: summary: Create a discussion comment (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. Creates a new comment on a team discussion. @@ -40646,7 +41891,7 @@ paths: summary: Get a discussion comment (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. Get a specific comment on a team discussion. @@ -40683,7 +41928,7 @@ paths: summary: Update a discussion comment (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. Edits the body text of a discussion comment. @@ -40736,7 +41981,7 @@ paths: summary: Delete a discussion comment (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. Deletes a comment on a team discussion. @@ -40767,7 +42012,7 @@ paths: summary: List reactions for a team discussion comment (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). @@ -40827,7 +42072,7 @@ paths: summary: Create reaction for a team discussion comment (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). @@ -40893,7 +42138,7 @@ paths: summary: List reactions for a team discussion (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). @@ -40952,7 +42197,7 @@ paths: summary: Create reaction for a team discussion (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). @@ -41017,7 +42262,7 @@ paths: summary: List pending team invitations (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. tags: @@ -41058,7 +42303,7 @@ paths: summary: List team members (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. Team members will include the members of child teams. tags: @@ -41111,7 +42356,7 @@ paths: get: summary: Get team member (Legacy) description: |- - The "Get team member" endpoint (described below) is deprecated. + The "Get team member" endpoint (described below) is closing down. We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. @@ -41141,7 +42386,7 @@ paths: put: summary: Add team member (Legacy) description: |- - The "Add team member" endpoint (described below) is deprecated. + The "Add team member" endpoint (described below) is closing down. We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. @@ -41184,7 +42429,7 @@ paths: delete: summary: Remove team member (Legacy) description: |- - The "Remove team member" endpoint (described below) is deprecated. + The "Remove team member" endpoint (described below) is closing down. We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. @@ -41221,7 +42466,7 @@ paths: summary: Get team membership for a user (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. Team members will include the members of child teams. @@ -41264,7 +42509,7 @@ paths: summary: Add or update team membership for a user (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -41333,7 +42578,7 @@ paths: summary: Remove team membership for a user (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -41368,7 +42613,7 @@ paths: summary: List team projects (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. Lists the organization projects for a team. tags: @@ -41411,7 +42656,7 @@ paths: summary: Check team permissions for a project (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. tags: @@ -41447,7 +42692,7 @@ paths: summary: Add or update team project permissions (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. tags: @@ -41518,7 +42763,7 @@ paths: summary: Remove a project from a team (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. tags: @@ -41550,7 +42795,7 @@ paths: summary: List team repositories (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. tags: - teams operationId: teams/list-repos-legacy @@ -41591,7 +42836,7 @@ paths: summary: Check team permissions for a repository (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. > [!NOTE] > Repositories inherited through a parent team will also be checked. @@ -41633,7 +42878,7 @@ paths: summary: Add or update team repository permissions (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. @@ -41689,7 +42934,7 @@ paths: summary: Remove a repository from a team (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. tags: @@ -41718,7 +42963,7 @@ paths: summary: List child teams (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. tags: - teams operationId: teams/list-child-legacy @@ -41779,6 +43024,11 @@ paths: oneOf: - "$ref": "#/components/schemas/private-user" - "$ref": "#/components/schemas/public-user" + discriminator: + propertyName: user_view_type + mapping: + public: "#/components/schemas/public-user" + private: "#/components/schemas/private-user" examples: response-with-public-and-private-profile-information: "$ref": "#/components/examples/private-user-response-with-public-and-private-profile-information" @@ -42103,7 +43353,7 @@ paths: geo: description: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, - which is being deprecated. + which is closing down. type: string enum: - EuropeWest @@ -42162,7 +43412,7 @@ paths: geo: description: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, - which is being deprecated. + which is closing down. type: string enum: - EuropeWest @@ -43436,6 +44686,8 @@ paths: "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -44746,6 +45998,9 @@ paths: List organizations for the authenticated user. For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + + > [!NOTE] + > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. tags: - orgs operationId: orgs/list-for-authenticated-user @@ -44787,7 +46042,7 @@ paths: description: |- Lists packages owned by the authenticated user within the user's namespace. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-authenticated-user @@ -44840,7 +46095,7 @@ paths: description: |- Gets a specific package for a package owned by the authenticated user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-authenticated-user @@ -44870,7 +46125,7 @@ paths: description: |- Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-authenticated-user @@ -44904,7 +46159,7 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-authenticated-user @@ -44940,7 +46195,7 @@ paths: description: |- Lists package versions for a package owned by the authenticated user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-authenticated-user @@ -44991,7 +46246,7 @@ paths: description: |- Gets a specific package version for a package owned by the authenticated user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-authenticated-user @@ -45024,7 +46279,7 @@ paths: The authenticated user must have admin permissions in the organization to use this endpoint. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-authenticated-user @@ -45059,7 +46314,7 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-authenticated-user @@ -46205,6 +47460,11 @@ paths: oneOf: - "$ref": "#/components/schemas/private-user" - "$ref": "#/components/schemas/public-user" + discriminator: + propertyName: user_view_type + mapping: + public: "#/components/schemas/public-user" + private: "#/components/schemas/private-user" examples: default-response: "$ref": "#/components/examples/public-user-default-response" @@ -46283,6 +47543,11 @@ paths: oneOf: - "$ref": "#/components/schemas/private-user" - "$ref": "#/components/schemas/public-user" + discriminator: + propertyName: user_view_type + mapping: + public: "#/components/schemas/public-user" + private: "#/components/schemas/private-user" examples: default-response: "$ref": "#/components/examples/public-user-default-response" @@ -46400,7 +47665,7 @@ paths: get: summary: List events for the authenticated user description: |- - If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). > [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. @@ -46831,7 +48096,7 @@ paths: description: |- Lists all packages in a user's namespace for which the requesting user has access. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-user @@ -46889,7 +48154,7 @@ paths: description: |- Gets a specific package metadata for a public package owned by a user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-user @@ -46922,7 +48187,7 @@ paths: If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-user @@ -46959,7 +48224,7 @@ paths: If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-user @@ -46996,7 +48261,7 @@ paths: description: |- Lists package versions for a public package owned by a specified user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-user @@ -47036,7 +48301,7 @@ paths: description: |- Gets a specific package version for a public package owned by a specified user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-user @@ -47070,7 +48335,7 @@ paths: If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-user @@ -47108,7 +48373,7 @@ paths: If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-user @@ -49355,7 +50620,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > Webhook events for Dependabot alerts are currently in beta and subject to change. + > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A Dependabot alert was automatically closed by a Dependabot auto-triage rule. operationId: dependabot-alert/auto-dismissed @@ -49425,7 +50690,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > Webhook events for Dependabot alerts are currently in beta and subject to change. + > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed. @@ -49496,7 +50761,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > Webhook events for Dependabot alerts are currently in beta and subject to change. + > Webhook events for Dependabot alerts are currently in public preview and subject to change. 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. @@ -49567,7 +50832,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > Webhook events for Dependabot alerts are currently in beta and subject to change. + > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A Dependabot alert was manually closed. operationId: dependabot-alert/dismissed externalDocs: @@ -49636,7 +50901,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > Webhook events for Dependabot alerts are currently in beta and subject to change. + > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A manifest file change removed a vulnerability. operationId: dependabot-alert/fixed externalDocs: @@ -49705,7 +50970,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > Webhook events for Dependabot alerts are currently in beta and subject to change. + > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A manifest file change introduced a vulnerable dependency that had previously been fixed. operationId: dependabot-alert/reintroduced @@ -49775,7 +51040,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > Webhook events for Dependabot alerts are currently in beta and subject to change. + > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A Dependabot alert was manually reopened. operationId: dependabot-alert/reopened externalDocs: @@ -50361,7 +51626,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A comment on the discussion was marked as the answer. operationId: discussion/answered externalDocs: @@ -50430,7 +51695,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: The category of a discussion was changed. operationId: discussion/category-changed externalDocs: @@ -50499,7 +51764,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was closed. operationId: discussion/closed externalDocs: @@ -50568,7 +51833,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A comment on a discussion was created. operationId: discussion-comment/created externalDocs: @@ -50637,7 +51902,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A comment on a discussion was deleted. operationId: discussion-comment/deleted externalDocs: @@ -50706,7 +51971,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A comment on a discussion was edited. operationId: discussion-comment/edited externalDocs: @@ -50775,7 +52040,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was created. operationId: discussion/created externalDocs: @@ -50844,7 +52109,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was deleted. operationId: discussion/deleted externalDocs: @@ -50913,7 +52178,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: The title or body on a discussion was edited, or the category of the discussion was changed. operationId: discussion/edited @@ -50983,7 +52248,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A label was added to a discussion. operationId: discussion/labeled externalDocs: @@ -51052,7 +52317,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was locked. operationId: discussion/locked externalDocs: @@ -51121,7 +52386,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was pinned. operationId: discussion/pinned externalDocs: @@ -51190,7 +52455,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was reopened. operationId: discussion/reopened externalDocs: @@ -51259,7 +52524,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was transferred to another repository. operationId: discussion/transferred externalDocs: @@ -51328,7 +52593,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A comment on the discussion was unmarked as the answer. operationId: discussion/unanswered externalDocs: @@ -51397,7 +52662,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A label was removed from a discussion. operationId: discussion/unlabeled externalDocs: @@ -51466,7 +52731,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was unlocked. operationId: discussion/unlocked externalDocs: @@ -51535,7 +52800,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was unpinned. operationId: discussion/unpinned externalDocs: @@ -55588,7 +56853,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. > [!NOTE] - > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was approved. operationId: personal-access-token-request/approved externalDocs: @@ -55653,7 +56918,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. > [!NOTE] - > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was cancelled by the requester. operationId: personal-access-token-request/cancelled @@ -55719,7 +56984,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. > [!NOTE] - > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was created. operationId: personal-access-token-request/created externalDocs: @@ -55784,7 +57049,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. > [!NOTE] - > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was denied. operationId: personal-access-token-request/denied externalDocs: @@ -56877,7 +58142,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was closed. operationId: projects-v2/closed externalDocs: @@ -56945,7 +58210,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was created. operationId: projects-v2/created externalDocs: @@ -57013,7 +58278,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was deleted. operationId: projects-v2/deleted externalDocs: @@ -57081,7 +58346,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: The title, description, or README of a project in the organization was changed. operationId: projects-v2/edited @@ -57150,7 +58415,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). 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)." operationId: projects-v2-item/archived @@ -57219,7 +58484,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A draft issue in an organization project was converted to an issue. operationId: projects-v2-item/converted externalDocs: @@ -57287,7 +58552,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: An item was added to a project in the organization. operationId: projects-v2-item/created externalDocs: @@ -57355,7 +58620,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: An item was deleted from a project in the organization. operationId: projects-v2-item/deleted externalDocs: @@ -57423,7 +58688,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). 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. @@ -57493,7 +58758,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). 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. @@ -57563,7 +58828,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). 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)." operationId: projects-v2-item/restored @@ -57632,7 +58897,7 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was reopened. operationId: projects-v2/reopened externalDocs: @@ -61583,7 +62848,7 @@ webhooks: This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] - > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. + > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. description: A repository vulnerability alert was created. operationId: repository-vulnerability-alert/create externalDocs: @@ -61647,7 +62912,7 @@ webhooks: This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] - > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. + > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. description: A repository vulnerability alert was dismissed. operationId: repository-vulnerability-alert/dismiss externalDocs: @@ -61711,7 +62976,7 @@ webhooks: This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] - > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. + > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. description: A previously dismissed or resolved repository vulnerability alert was reopened. operationId: repository-vulnerability-alert/reopen @@ -61776,7 +63041,7 @@ webhooks: This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] - > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. + > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. description: A repository vulnerability alert was marked as resolved. operationId: repository-vulnerability-alert/resolve externalDocs: @@ -61979,7 +63244,7 @@ webhooks: - repository - organization - app - secret-scanning-alert-reopened: + secret-scanning-alert-publicly-leaked: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -61987,8 +63252,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A previously closed secret scanning alert was reopened. - operationId: secret-scanning-alert/reopened + description: A secret scanning alert was detected in a public repo. + operationId: secret-scanning-alert/publicly-leaked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -62032,7 +63297,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62045,7 +63310,7 @@ webhooks: - repository - organization - app - secret-scanning-alert-resolved: + secret-scanning-alert-reopened: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -62053,8 +63318,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was closed. - operationId: secret-scanning-alert/resolved + description: A previously closed secret scanning alert was reopened. + operationId: secret-scanning-alert/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -62098,7 +63363,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62111,7 +63376,7 @@ webhooks: - repository - organization - app - secret-scanning-alert-validated: + secret-scanning-alert-resolved: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -62119,8 +63384,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was validated. - operationId: secret-scanning-alert/validated + description: A secret scanning alert was closed. + operationId: secret-scanning-alert/resolved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -62164,7 +63429,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62177,16 +63442,18 @@ webhooks: - repository - organization - app - security-advisory-published: + secret-scanning-alert-validated: post: summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A security advisory was published to the GitHub community. - operationId: security-advisory/published + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was validated. + operationId: secret-scanning-alert/validated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -62228,7 +63495,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62236,17 +63503,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: secret_scanning_alert supported-webhook-types: + - repository + - organization - app - security-advisory-updated: + security-advisory-published: post: summary: |- This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: The metadata or description of a security advisory was changed. - operationId: security-advisory/updated + description: A security advisory was published to the GitHub community. + operationId: security-advisory/published externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: @@ -62290,7 +63559,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-security-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62301,14 +63570,14 @@ webhooks: subcategory: security_advisory supported-webhook-types: - app - security-advisory-withdrawn: + security-advisory-updated: post: summary: |- This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A previously published security advisory was withdrawn. - operationId: security-advisory/withdrawn + description: The metadata or description of a security advisory was changed. + operationId: security-advisory/updated externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: @@ -62352,7 +63621,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62363,15 +63632,16 @@ webhooks: subcategory: security_advisory supported-webhook-types: - app - security-and-analysis: + security-advisory-withdrawn: post: summary: |- - This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - operationId: security-and-analysis + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + description: A previously published security advisory was withdrawn. + operationId: security-advisory/withdrawn externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -62413,7 +63683,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62421,151 +63691,18 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_and_analysis + subcategory: security_advisory supported-webhook-types: - - repository - - organization - app - sponsorship-cancelled: - post: - summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsorship was cancelled and the last billing cycle has ended. - - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/cancelled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sponsorship - supported-webhook-types: - - sponsors_listing - sponsorship-created: - post: - summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor created a sponsorship for a sponsored account. This event - occurs once the payment is successfully processed. - operationId: sponsorship/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-sponsorship-created" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sponsorship - supported-webhook-types: - - sponsors_listing - sponsorship-edited: + security-and-analysis: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - 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. - operationId: sponsorship/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + operationId: security-and-analysis externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis parameters: - name: User-Agent in: header @@ -62607,7 +63744,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-security-and-analysis" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62615,20 +63752,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: security_and_analysis supported-webhook-types: - - sponsors_listing - sponsorship-pending-cancellation: + - repository + - organization + - app + sponsorship-cancelled: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: |- - A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. + A sponsorship was cancelled and the last billing cycle has ended. This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/pending-cancellation + operationId: sponsorship/cancelled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -62672,7 +63811,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62683,15 +63822,15 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-pending-tier-change: + sponsorship-created: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor scheduled a downgrade to a lower sponsorship tier. The - new tier will become effective on their next billing date. - operationId: sponsorship/pending-tier-change + description: A sponsor created a sponsorship for a sponsored account. This event + occurs once the payment is successfully processed. + operationId: sponsorship/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -62735,7 +63874,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62746,17 +63885,16 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-tier-changed: + sponsorship-edited: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - 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. - operationId: sponsorship/tier-changed + 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. + operationId: sponsorship/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -62800,7 +63938,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62811,16 +63949,19 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - star-created: + sponsorship-pending-cancellation: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone starred a repository. - operationId: star/created + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: |- + A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. + + This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. + operationId: sponsorship/pending-cancellation externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -62862,7 +64003,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62870,21 +64011,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - star-deleted: + - sponsors_listing + sponsorship-pending-tier-change: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone unstarred the repository. - operationId: star/deleted + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: A sponsor scheduled a downgrade to a lower sponsorship tier. The + new tier will become effective on their next billing date. + operationId: sponsorship/pending-tier-change externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -62926,7 +64066,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62934,20 +64074,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - status: + - sponsors_listing + sponsorship-tier-changed: post: summary: |- - This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. - operationId: status + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + 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. + operationId: sponsorship/tier-changed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#status + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -62989,7 +64131,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62997,23 +64139,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: status + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - sub-issues-parent-issue-added: + - sponsors_listing + star-created: post: summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A parent issue was added to an issue. - operationId: sub-issues/parent-issue-added + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone starred a repository. + operationId: star/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -63055,7 +64193,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-star-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63063,23 +64201,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: star supported-webhook-types: - repository - organization - app - sub-issues-parent-issue-removed: + star-deleted: post: summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A parent issue was removed from an issue. - operationId: sub-issues/parent-issue-removed + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone unstarred the repository. + operationId: star/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -63121,7 +64257,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-star-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63129,23 +64265,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: star supported-webhook-types: - repository - organization - app - sub-issues-sub-issue-added: + status: post: summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. + This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A sub-issue was added to an issue. - operationId: sub-issues/sub-issue-added + To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. + operationId: status externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#status parameters: - name: User-Agent in: header @@ -63187,7 +64320,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-status" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63195,12 +64328,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: status supported-webhook-types: - repository - organization - app - sub-issues-sub-issue-removed: + sub-issues-parent-issue-added: post: summary: |- This event occurs when there is activity relating to sub-issues. @@ -63208,8 +64341,8 @@ webhooks: For activity relating to issues more generally, use the `issues` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A sub-issue was removed from an issue. - operationId: sub-issues/sub-issue-removed + description: A parent issue was added to an issue. + operationId: sub-issues/parent-issue-added externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: @@ -63253,7 +64386,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63266,18 +64399,18 @@ webhooks: - repository - organization - app - team-add: + sub-issues-parent-issue-removed: post: summary: |- - This event occurs when a team is added to a repository. - For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + This event occurs when there is activity relating to sub-issues. - For activity relating to teams, see the `teams` event. + For activity relating to issues more generally, use the `issues` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - operationId: team-add + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A parent issue was removed from an issue. + operationId: sub-issues/parent-issue-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -63319,7 +64452,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63327,22 +64460,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team_add + subcategory: sub-issues supported-webhook-types: - repository - organization - app - team-added-to-repository: + sub-issues-sub-issue-added: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when there is activity relating to sub-issues. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was granted access to a repository. - operationId: team/added-to-repository + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A sub-issue was added to an issue. + operationId: sub-issues/sub-issue-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -63384,7 +64518,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63392,22 +64526,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sub-issues supported-webhook-types: + - repository - organization - - business - app - team-created: + sub-issues-sub-issue-removed: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when there is activity relating to sub-issues. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was created. - operationId: team/created + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A sub-issue was removed from an issue. + operationId: sub-issues/sub-issue-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -63449,7 +64584,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63457,22 +64592,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sub-issues supported-webhook-types: + - repository - organization - - business - app - team-deleted: + team-add: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when a team is added to a repository. + For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + + For activity relating to teams, see the `teams` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was deleted. - operationId: team/deleted + operationId: team-add externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add parameters: - name: User-Agent in: header @@ -63514,7 +64650,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-add" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63522,20 +64658,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: team_add supported-webhook-types: + - repository - organization - - business - app - team-edited: + team-added-to-repository: post: summary: |- This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: The name, description, or visibility of a team was changed. - operationId: team/edited + description: A team was granted access to a repository. + operationId: team/added-to-repository externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: @@ -63579,7 +64715,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-team-added-to-repository" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63592,15 +64728,15 @@ webhooks: - organization - business - app - team-removed-from-repository: + team-created: post: summary: |- This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team's access to a repository was removed. - operationId: team/removed-from-repository + description: A team was created. + operationId: team/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: @@ -63644,7 +64780,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-team-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63657,16 +64793,17 @@ webhooks: - organization - business - app - watch-started: + team-deleted: post: summary: |- - This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/rest/activity/watching)" in the REST API documentation. + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone started watching the repository. - operationId: watch/started + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team was deleted. + operationId: team/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#watch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -63708,7 +64845,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-team-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63716,22 +64853,216 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: watch + subcategory: team supported-webhook-types: - - repository - organization + - business - app - workflow-dispatch: + team-edited: post: summary: |- - This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow)." - - For activity relating to workflow runs, use the `workflow_run` event. + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: workflow-dispatch + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: The name, description, or visibility of a team was changed. + operationId: team/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-team-edited" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: team + supported-webhook-types: + - organization + - business + - app + team-removed-from-repository: + post: + summary: |- + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team's access to a repository was removed. + operationId: team/removed-from-repository + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-team-removed-from-repository" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: team + supported-webhook-types: + - organization + - business + - app + watch-started: + post: + summary: |- + This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/rest/activity/watching)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone started watching the repository. + operationId: watch/started + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#watch + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-watch-started" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: watch + supported-webhook-types: + - repository + - organization + - app + workflow-dispatch: + post: + summary: |- + This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow)." + + For activity relating to workflow runs, use the `workflow_run` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + operationId: workflow-dispatch + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch parameters: - name: User-Agent in: header @@ -64599,6 +65930,10 @@ components: type: string examples: - '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + examples: + - public required: - avatar_url - events_url @@ -65640,7 +66975,8 @@ components: type: string description: The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot - Business subscription. This property is in beta and is subject to change. + Business subscription. This property is in public preview and is subject + to change. enum: - write organization_announcement_banners: @@ -65687,7 +67023,7 @@ components: organization_projects: type: string description: The level of permission to grant the access token to manage - organization projects and projects beta (where available). + organization projects and projects public preview (where available). enum: - read - write @@ -66339,7 +67675,7 @@ components: use_squash_pr_title_as_default: type: boolean description: Whether a squash merge commit can use the pull request title - as default. **This property has been deprecated. Please use `squash_merge_commit_title` + as default. **This property is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true @@ -67496,10 +68832,10 @@ components: - disabled | all group_id: type: - - integer + - string - 'null' examples: - - 1 + - 62ab9291-fae2-468e-974b-7e45096d5021 html_url: type: string format: uri @@ -67530,17 +68866,10 @@ components: type: object properties: assignee: - type: object - description: The assignee that has been granted access to GitHub Copilot. - additionalProperties: true - oneOf: - - "$ref": "#/components/schemas/simple-user" + "$ref": "#/components/schemas/simple-user" organization: - type: - - object - - 'null' - description: The organization to which this seat belongs. - oneOf: + anyOf: + - type: 'null' - "$ref": "#/components/schemas/organization-simple" assigning_team: description: The team through which the assignee is granted access to GitHub @@ -67583,10 +68912,307 @@ components: format: date-time description: Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + plan_type: + type: string + description: The Copilot plan of the organization, or the parent enterprise, + when applicable. + enum: + - business + - enterprise + - unknown required: - assignee - created_at additionalProperties: false + copilot-ide-code-completions: + type: + - object + - 'null' + description: Usage metrics for Copilot editor code completions in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code suggestion, + across all active editors. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the given editor for + Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given language. Includes both full + and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given editor. Includes both full and + partial acceptances. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code completion suggestion for the given editor, for the given + language and model. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages, for + the given editor. + items: + type: object + description: Usage metrics for a given language for the given + editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code + completion suggestions, for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one + Copilot code completion suggestion for the given editor, + for the given language. Includes both full and partial + acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code suggestions generated + for the given editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code suggestions accepted + for the given editor, for the given language. Includes + both full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code suggested by + Copilot code completions for the given editor, for the + given language. + total_code_lines_accepted: + type: integer + description: The number of lines of code accepted from + Copilot code suggestions for the given editor, for the + given language. + copilot-ide-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in the + specified editor. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in + the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated by users in + the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted a code suggestion + from Copilot Chat using the 'Insert Code' UI element, for + the given editor. + total_chat_copy_events: + type: integer + description: The number of times users copied a code suggestion + from Copilot Chat using the keyboard, or the 'Copy' UI element, + for the given editor. + copilot-dotcom-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in github.com + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once. + models: + type: array + description: List of model metrics for a custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model (if applicable). + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users on github.com. + copilot-dotcom-pull-requests: + type: + - object + - 'null' + description: Usage metrics for Copilot for pull requests. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull Requests on github.com + to generate a pull request summary at least once. + repositories: + type: array + description: Repositories in which users used Copilot for Pull Requests + to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull request summaries + using Copilot for Pull Requests in the given repository. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries generated + using Copilot for Pull Requests in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated pull request + summaries using Copilot for Pull Requests in the given repository + and model. + copilot-usage-metrics-day: + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` + format. + total_active_users: + type: integer + description: The total number of Copilot users with activity belonging to + any Copilot feature, globally, for the given day. Includes passive activity + such as receiving a code suggestion, as well as engagement activity such + as accepting a code suggestion or prompting chat. Does not include authentication + events. Is not limited to the individual features detailed on the endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with any Copilot + feature, for the given day. Examples include but are not limited to accepting + a code suggestion, prompting Copilot chat, or triggering a PR Summary. + Does not include authentication events. Is not limited to the individual + features detailed on the endpoint. + copilot_ide_code_completions: + "$ref": "#/components/schemas/copilot-ide-code-completions" + copilot_ide_chat: + "$ref": "#/components/schemas/copilot-ide-chat" + copilot_dotcom_chat: + "$ref": "#/components/schemas/copilot-dotcom-chat" + copilot_dotcom_pull_requests: + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + required: + - date + additionalProperties: true copilot-usage-metrics: title: Copilot Usage Metrics description: Summary of Copilot usage. @@ -68443,6 +70069,17 @@ components: - active - inactive - unknown + publicly_leaked: + type: + - boolean + - 'null' + description: Whether the secret was publicly leaked. + multi_repo: + type: + - boolean + - 'null' + description: Whether the detected secret was found in multiple repositories + in the same organization or enterprise. actor: title: Actor description: Actor @@ -69117,6 +70754,11 @@ components: type: string size: type: integer + encoding: + type: string + description: The encoding used for `content`. Currently, `"utf-8"` + and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -69175,6 +70817,8 @@ components: id: type: integer format: int64 + user_view_type: + type: string node_id: type: string avatar_url: @@ -69285,11 +70929,6 @@ components: - name - space - private_repos - suspended_at: - type: - - string - - 'null' - format: date-time private_gists: type: integer examples: @@ -69533,6 +71172,11 @@ components: type: boolean content: type: string + encoding: + type: string + description: The encoding used for `content`. Currently, `"utf-8"` + and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -70136,6 +71780,14 @@ components: enum: - enabled - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled minimal-repository: title: Minimal Repository description: Minimal Repository @@ -70766,6 +72418,10 @@ components: type: - integer - 'null' + description: |- + The number of collaborators on private repositories. + + This field may be null if the number of private repositories is over 50,000. examples: - 8 billing_email: @@ -70849,7 +72505,7 @@ components: advanced_security_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. @@ -70860,7 +72516,7 @@ components: dependabot_alerts_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. @@ -70871,7 +72527,7 @@ components: dependabot_security_updates_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. @@ -70882,7 +72538,7 @@ components: dependency_graph_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. @@ -70893,7 +72549,7 @@ components: secret_scanning_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. @@ -70904,7 +72560,7 @@ components: secret_scanning_push_protection_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. @@ -70939,6 +72595,12 @@ components: - string - 'null' format: date-time + deploy_keys_enabled_for_repositories: + type: boolean + description: Controls whether or not deploy keys may be added and used for + repositories in the organization. + examples: + - false required: - login - url @@ -71106,6 +72768,60 @@ components: "$ref": "#/components/schemas/actions-default-workflow-permissions" can_approve_pull_request_reviews: "$ref": "#/components/schemas/actions-can-approve-pull-request-reviews" + runner-groups-org: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_repositories_url: + description: Link to the selected repositories resource for this runner + group. Not present unless visibility was set to `selected` + type: string + runners_url: + type: string + hosted_runners_url: + type: string + inherited: + type: boolean + inherited_allows_public_repositories: + type: boolean + allows_public_repositories: + type: boolean + workflow_restrictions_read_only: + description: If `true`, the `restricted_to_workflows` and `selected_workflows` + fields cannot be modified. + type: boolean + default: false + restricted_to_workflows: + description: If `true`, the runner group will be restricted to running only + the workflows specified in the `selected_workflows` array. + type: boolean + default: false + selected_workflows: + description: List of workflows the runner group should be allowed to run. + This setting will be ignored unless `restricted_to_workflows` is set to + `true`. + type: array + items: + type: string + description: Name of workflow the runner group should be allowed to run. + Note that a ref, tag, or long SHA is required. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - id + - name + - visibility + - default + - runners_url + - inherited + - allows_public_repositories runner-label: title: Self hosted runner label description: A label for a self hosted runner @@ -71383,12 +73099,15 @@ components: format: uri readOnly: true code-scanning-alert-state: - type: string + type: + - string + - 'null' description: State of a code scanning alert. enum: - open - dismissed - fixed + - code-scanning-alert-dismissed-reason: type: - string @@ -71621,6 +73340,7 @@ components: enum: - global - organization + - enterprise description: type: string description: A description of the code security configuration @@ -71687,6 +73407,35 @@ components: - enabled - disabled - not_set + secret_scanning_delegated_bypass: + type: string + description: The enablement status of secret scanning delegated bypass + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass_options: + type: object + description: Feature options for secret scanning delegated bypass + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE secret_scanning_validity_checks: type: string description: The enablement status of secret scanning validity checks @@ -72180,9 +73929,9 @@ components: description: The number of seats that have not used Copilot during the current billing cycle. copilot-organization-details: - title: Copilot Business Organization Details + title: Copilot Organization Details description: Information about the seat breakdown and policies set for an organization - with a Copilot Business subscription. + with a Copilot Business or Copilot Enterprise subscription. type: object properties: seat_breakdown: @@ -72228,6 +73977,14 @@ components: - assign_selected - disabled - unconfigured + plan_type: + type: string + description: The Copilot plan of the organization, or the parent enterprise, + when applicable. + enum: + - business + - enterprise + - unknown required: - seat_breakdown - public_code_suggestions @@ -72489,6 +74246,121 @@ components: - ping_url - created_at - updated_at + api-insights-route-stats: + title: Route Stats + description: API Insights usage route stats for an actor + type: array + items: + type: object + properties: + http_method: + description: The HTTP method + type: string + api_route: + description: The API path's route template + type: string + total_request_count: + description: The total number of requests within the queried time period + type: integer + format: int64 + rate_limited_request_count: + description: The total number of requests that were rate limited within + the queried time period + type: integer + format: int64 + last_rate_limited_timestamp: + type: + - string + - 'null' + last_request_timestamp: + type: string + api-insights-subject-stats: + title: Subject Stats + description: API Insights usage subject stats for an organization + type: array + items: + type: object + properties: + subject_type: + type: string + subject_name: + type: string + subject_id: + type: integer + format: int64 + total_request_count: + type: integer + rate_limited_request_count: + type: integer + last_rate_limited_timestamp: + type: + - string + - 'null' + last_request_timestamp: + type: string + api-insights-summary-stats: + title: Summary Stats + description: API Insights usage summary stats for an organization + type: object + properties: + total_request_count: + description: The total number of requests within the queried time period + type: integer + format: int64 + rate_limited_request_count: + description: The total number of requests that were rate limited within + the queried time period + type: integer + format: int64 + api-insights-time-stats: + title: Time Stats + description: API Insights usage time stats for an organization + type: array + items: + type: object + properties: + timestamp: + type: string + total_request_count: + type: integer + format: int64 + rate_limited_request_count: + type: integer + format: int64 + api-insights-user-stats: + title: User Stats + description: API Insights usage stats for a user + type: array + items: + type: object + properties: + actor_type: + type: string + actor_name: + type: string + actor_id: + type: integer + format: int64 + integration_id: + type: + - integer + - 'null' + format: int64 + oauth_application_id: + type: + - integer + - 'null' + format: int64 + total_request_count: + type: integer + rate_limited_request_count: + type: integer + last_rate_limited_timestamp: + type: + - string + - 'null' + last_request_timestamp: + type: string interaction-group: type: string description: The type of GitHub user that can comment, open issues, or create @@ -72894,6 +74766,10 @@ components: type: string examples: - '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + examples: + - public required: - avatar_url - events_url @@ -73053,6 +74929,15 @@ components: created_at: type: string description: Date and time when the request for access was created. + token_id: + type: integer + description: Unique identifier of the user's token. This field can also + be found in audit log events and the organization's settings for their + PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -73077,6 +74962,8 @@ components: - repositories_url - permissions - created_at + - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -73088,9 +74975,9 @@ components: properties: id: type: integer - description: Unique identifier of the fine-grained personal access token. - The `pat_id` used to get details about an approved fine-grained personal - access token. + description: Unique identifier of the fine-grained personal access token + grant. The `pat_id` used to get details about an approved fine-grained + personal access token. owner: "$ref": "#/components/schemas/simple-user" repository_selection: @@ -73124,6 +75011,15 @@ components: type: string description: Date and time when the fine-grained personal access token was approved to access the organization. + token_id: + type: integer + description: Unique identifier of the user's token. This field can also + be found in audit log events and the organization's settings for their + PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -73147,6 +75043,8 @@ components: - repositories_url - permissions - access_granted_at + - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -73959,7 +75857,6 @@ components: description: An actor that can bypass rules in a ruleset required: - actor_type - - bypass_mode properties: actor_id: type: @@ -73982,10 +75879,12 @@ components: type: string description: When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` - is not applicable for the `DeployKey` actor type. + is not applicable for the `DeployKey` actor type. Also, `pull_request` + is only applicable to branch rulesets. enum: - always - pull_request + default: always repository-ruleset-conditions: title: Repository ruleset conditions for ref names type: object @@ -74097,9 +75996,10 @@ components: org-ruleset-conditions: title: Organization ruleset conditions type: object - description: Conditions for an organization ruleset. The conditions object should - contain both `repository_name` and `ref_name` properties or both `repository_id` - and `ref_name` properties. + description: |- + Conditions for an organization ruleset. + The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + The push rulesets conditions object does not require the `ref_name` property. oneOf: - type: object title: repository_name_and_ref_name @@ -74277,6 +76177,31 @@ components: type: string enum: - required_signatures + repository-rule-params-required-reviewer-configuration: + title: RequiredReviewerConfiguration + description: A reviewing team, and file patterns describing which files they + must approve changes to. + type: object + properties: + file_patterns: + type: array + description: Array of file patterns. Pull requests which change matching + files must be approved by the specified team. File patterns use the same + syntax as `.gitignore` files. + items: + type: string + minimum_approvals: + type: integer + description: Minimum number of approvals required from the specified team. + If set to zero, the team will be added to the pull request but approval + is optional. + reviewer_id: + type: string + description: Node ID of the team which must review changes to matching files. + required: + - file_patterns + - minimum_approvals + - reviewer_id repository-rule-pull-request: title: pull_request description: Require all commits be made to a non-target branch and submitted @@ -74834,7 +76759,9 @@ components: type: string description: The URL of the ruleset html: - type: object + type: + - object + - 'null' properties: href: type: string @@ -78413,6 +80340,8 @@ components: type: string site_admin: type: boolean + user_view_type: + type: string teams: type: array items: @@ -78530,6 +80459,10 @@ components: type: boolean examples: - false + user_view_type: + type: string + examples: + - public name: type: string client_id: @@ -79490,6 +81423,7 @@ components: properties: id: type: integer + format: int64 examples: - 5 node_id: @@ -80561,6 +82495,10 @@ components: type: string examples: - admin + user_view_type: + type: string + examples: + - public required: - avatar_url - events_url @@ -81378,6 +83316,8 @@ components: type: string sha: type: string + content: + type: string url: type: string format: uri @@ -81409,8 +83349,6 @@ components: type: string path: type: string - content: - type: string sha: type: string url: @@ -81493,8 +83431,6 @@ components: - size - type - url - - content - - encoding content-directory: title: Content Directory description: A list of directory items @@ -81977,6 +83913,8 @@ components: type: string name: type: string + user_view_type: + type: string required: - contributions - type @@ -82205,6 +84143,12 @@ components: conforms to. examples: - SPDX-2.3 + comment: + type: string + description: An optional comment about the SPDX document. + examples: + - 'Exact versions could not be resolved for some packages. For more + information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/' creationInfo: type: object properties: @@ -82233,18 +84177,11 @@ components: description: The license under which the SPDX document is licensed. examples: - CC0-1.0 - documentDescribes: - type: array - items: - type: string - examples: - - github/github - description: The name of the repository that the SPDX document describes. documentNamespace: type: string description: The namespace for the SPDX document. examples: - - https://github.com/example/dependency_graph/sbom-123 + - https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: type: array items: @@ -82259,7 +84196,7 @@ components: type: string description: The name of the package. examples: - - rubygems:github/github + - github/github versionInfo: type: string description: |- @@ -82339,14 +84276,34 @@ components: - versionInfo - downloadLocation - filesAnalyzed - - supplier + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + description: The type of relationship between the two SPDX elements. + examples: + - DEPENDS_ON + spdxElementId: + type: string + description: The SPDX identifier of the package that is the source + of the relationship. + relatedSpdxElement: + type: string + description: The SPDX identifier of the package that is the target + of the relationship. + required: + - relationshipType + - spdxElementId + - relatedSpdxElement required: - SPDXID - spdxVersion - creationInfo - name - dataLicense - - documentDescribes - documentNamespace - packages required: @@ -82584,7 +84541,7 @@ components: examples: - production target_url: - description: 'Deprecated: the URL to associate with this status.' + description: 'Closing down notice: the URL to associate with this status.' default: '' type: string format: uri @@ -84918,13 +86875,13 @@ components: - config/database.yaml position: description: The line index in the diff to which the comment applies. This - field is deprecated; use `line` instead. + field is closing down; use `line` instead. type: integer examples: - 1 original_position: description: The index of the original line in the diff to which the comment - applies. This field is deprecated; use `original_line` instead. + applies. This field is closing down; use `original_line` instead. type: integer examples: - 4 @@ -85298,6 +87255,8 @@ components: type: - string - 'null' + enabled: + type: boolean required: - id - key @@ -86051,463 +88010,11 @@ components: ref: type: string repo: - type: - - object - - 'null' - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - node_id: - type: string - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - name: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - format: uri - events_url: - type: string - followers_url: - type: string - format: uri - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - type: integer - node_id: - type: string - login: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - format: uri - type: - type: string - url: - type: string - format: uri - required: - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - format: uri - statuses_url: - type: string - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - url: - type: string - format: uri - clone_url: - type: string - default_branch: - type: string - forks: - type: integer - forks_count: - type: integer - git_url: - type: string - has_downloads: - type: boolean - has_issues: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - has_pages: - type: boolean - has_discussions: - type: boolean - homepage: - type: - - string - - 'null' - format: uri - language: - type: - - string - - 'null' - master_branch: - type: string - archived: - type: boolean - disabled: - type: boolean - visibility: - description: 'The repository visibility: public, private, or internal.' - type: string - mirror_url: - type: - - string - - 'null' - format: uri - open_issues: - type: integer - open_issues_count: - type: integer - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - push: - type: boolean - triage: - type: boolean - pull: - type: boolean - required: - - admin - - pull - - push - temp_clone_token: - type: string - allow_merge_commit: - type: boolean - allow_squash_merge: - type: boolean - allow_rebase_merge: - type: boolean - license: - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - url: - type: - - string - - 'null' - format: uri - spdx_id: - type: - - string - - 'null' - node_id: - type: string - required: - - key - - name - - url - - spdx_id - - node_id - pushed_at: - type: string - format: date-time - size: - type: integer - ssh_url: - type: string - stargazers_count: - type: integer - svn_url: - type: string - format: uri - topics: - type: array - items: - type: string - watchers: - type: integer - watchers_count: - type: integer - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - allow_forking: - type: boolean - is_template: - type: boolean - web_commit_signoff_required: - type: boolean - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - - clone_url - - default_branch - - forks - - forks_count - - git_url - - has_downloads - - has_issues - - has_projects - - has_wiki - - has_pages - - has_discussions - - homepage - - language - - archived - - disabled - - mirror_url - - open_issues - - open_issues_count - - license - - pushed_at - - size - - ssh_url - - stargazers_count - - svn_url - - watchers - - watchers_count - - created_at - - updated_at + "$ref": "#/components/schemas/repository" sha: type: string user: - type: object - properties: - avatar_url: - type: string - format: uri - events_url: - type: string - followers_url: - type: string - format: uri - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - type: integer - format: int64 - node_id: - type: string - login: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - format: uri - type: - type: string - url: - type: string - format: uri - required: - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url + "$ref": "#/components/schemas/simple-user" required: - label - ref @@ -86522,439 +88029,11 @@ components: ref: type: string repo: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - is_template: - type: boolean - node_id: - type: string - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - name: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - format: uri - events_url: - type: string - followers_url: - type: string - format: uri - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - type: integer - node_id: - type: string - login: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - format: uri - type: - type: string - url: - type: string - format: uri - required: - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - format: uri - statuses_url: - type: string - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - url: - type: string - format: uri - clone_url: - type: string - default_branch: - type: string - forks: - type: integer - forks_count: - type: integer - git_url: - type: string - has_downloads: - type: boolean - has_issues: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - has_pages: - type: boolean - has_discussions: - type: boolean - homepage: - type: - - string - - 'null' - format: uri - language: - type: - - string - - 'null' - master_branch: - type: string - archived: - type: boolean - disabled: - type: boolean - visibility: - description: 'The repository visibility: public, private, or internal.' - type: string - mirror_url: - type: - - string - - 'null' - format: uri - open_issues: - type: integer - open_issues_count: - type: integer - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - push: - type: boolean - triage: - type: boolean - pull: - type: boolean - required: - - admin - - pull - - push - temp_clone_token: - type: string - allow_merge_commit: - type: boolean - allow_squash_merge: - type: boolean - allow_rebase_merge: - type: boolean - license: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/license-simple" - pushed_at: - type: string - format: date-time - size: - type: integer - ssh_url: - type: string - stargazers_count: - type: integer - svn_url: - type: string - format: uri - topics: - type: array - items: - type: string - watchers: - type: integer - watchers_count: - type: integer - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - allow_forking: - type: boolean - web_commit_signoff_required: - type: boolean - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - - clone_url - - default_branch - - forks - - forks_count - - git_url - - has_downloads - - has_issues - - has_projects - - has_wiki - - has_pages - - has_discussions - - homepage - - language - - archived - - disabled - - mirror_url - - open_issues - - open_issues_count - - license - - pushed_at - - size - - ssh_url - - stargazers_count - - svn_url - - watchers - - watchers_count - - created_at - - updated_at + "$ref": "#/components/schemas/repository" sha: type: string user: - type: object - properties: - avatar_url: - type: string - format: uri - events_url: - type: string - followers_url: - type: string - format: uri - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - type: integer - format: int64 - node_id: - type: string - login: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - format: uri - type: - type: string - url: - type: string - format: uri - required: - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url + "$ref": "#/components/schemas/simple-user" required: - label - ref @@ -87703,6 +88782,17 @@ components: - active - inactive - unknown + publicly_leaked: + type: + - boolean + - 'null' + description: Whether the detected secret was publicly leaked. + multi_repo: + type: + - boolean + - 'null' + description: Whether the detected secret was found in multiple repositories + under the same organization or enterprise. secret-scanning-alert-resolution-comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -89572,6 +90662,8 @@ components: - string - 'null' format: date-time + user_view_type: + type: string required: - avatar_url - events_url @@ -89606,6 +90698,8 @@ components: format: int64 examples: - 1 + user_view_type: + type: string node_id: type: string examples: @@ -89798,11 +90892,6 @@ components: - name - space - private_repos - suspended_at: - type: - - string - - 'null' - format: date-time business_plus: type: boolean ldap_dn: @@ -91477,7 +92566,7 @@ components: use_squash_pr_title_as_default: type: boolean description: Whether a squash merge commit can use the pull request title - as default. **This property has been deprecated. Please use `squash_merge_commit_title` + as default. **This property is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true @@ -91629,123 +92718,6 @@ components: - watchers_count - created_at - updated_at - simple-user-webhooks: - title: Simple User - description: The GitHub user that triggered the event. This property is included - in every webhook payload. - type: object - properties: - name: - type: - - string - - 'null' - email: - type: - - string - - 'null' - login: - type: string - examples: - - octocat - id: - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDQ6VXNlcjE= - avatar_url: - type: string - format: uri - examples: - - https://github.com/images/error/octocat_happy.gif - gravatar_id: - type: - - string - - 'null' - examples: - - 41d064eb2195891e12d0413f63227ea7 - url: - type: string - format: uri - examples: - - https://api.github.com/users/octocat - html_url: - type: string - format: uri - examples: - - https://github.com/octocat - followers_url: - type: string - format: uri - examples: - - https://api.github.com/users/octocat/followers - following_url: - type: string - examples: - - https://api.github.com/users/octocat/following{/other_user} - gists_url: - type: string - examples: - - https://api.github.com/users/octocat/gists{/gist_id} - starred_url: - type: string - examples: - - https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: - type: string - format: uri - examples: - - https://api.github.com/users/octocat/subscriptions - organizations_url: - type: string - format: uri - examples: - - https://api.github.com/users/octocat/orgs - repos_url: - type: string - format: uri - examples: - - https://api.github.com/users/octocat/repos - events_url: - type: string - examples: - - https://api.github.com/users/octocat/events{/privacy} - received_events_url: - type: string - format: uri - examples: - - https://api.github.com/users/octocat/received_events - type: - type: string - examples: - - User - site_admin: - type: boolean - starred_at: - type: string - examples: - - '"2020-07-09T00:17:55Z"' - required: - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url webhooks_rule: title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch @@ -92153,6 +93125,8 @@ components: format: uri verified: type: boolean + enabled: + type: boolean required: - id - key @@ -92242,6 +93216,8 @@ components: type: string url: type: string + user_view_type: + type: string webhooks_reviewers: type: array items: @@ -92417,6 +93393,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -92562,6 +93540,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -92657,6 +93637,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -92865,6 +93847,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -93034,6 +94018,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -93291,6 +94277,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -93402,6 +94390,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -93474,6 +94464,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -93643,6 +94635,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -93862,6 +94856,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -94213,6 +95209,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -94320,6 +95318,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -94461,6 +95461,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -94532,6 +95534,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -94700,6 +95704,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -94917,6 +95923,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -95266,6 +96274,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -95358,6 +96368,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -95755,6 +96767,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -95897,6 +96911,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -96012,6 +97028,15 @@ components: created_at: type: string description: Date and time when the request for access was created. + token_id: + type: integer + description: Unique identifier of the user's token. This field can also + be found in audit log events and the organization's settings for their + PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -96038,6 +97063,8 @@ components: - repository_count - repositories - created_at + - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -96129,120 +97156,124 @@ components: url: type: string format: uri - required: - - login - - id - id: - description: The project card's ID - type: integer - node_id: - type: string - note: - type: - - string - - 'null' - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - column_url - - column_id - - id - - node_id - - note - - archived - - creator - - created_at - - updated_at - webhooks_project: - title: Project - type: object - properties: - body: - description: Body of the project - type: - - string - - 'null' - columns_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: + user_view_type: + type: string + required: + - login + - id + id: + description: The project card's ID + type: integer + node_id: + type: string + note: + type: + - string + - 'null' + project_url: + type: string + format: uri + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - project_url + - column_url + - column_id + - id + - node_id + - note + - archived + - creator + - created_at + - updated_at + webhooks_project: + title: Project + type: object + properties: + body: + description: Body of the project + type: + - string + - 'null' + columns_url: + type: string + format: uri + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri required: - login - id @@ -96619,7 +97650,7 @@ components: - COMMIT_OR_PR_TITLE use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull request title - as default. **This property has been deprecated. Please use `squash_merge_commit_title` + as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** type: boolean default: false @@ -96790,6 +97821,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -96961,6 +97994,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -97298,6 +98333,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -97570,6 +98607,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -97933,6 +98972,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -98205,6 +99246,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -98348,6 +99391,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -98435,6 +99480,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -98877,6 +99924,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -99172,6 +100221,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -99335,6 +100386,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -99552,6 +100605,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -99890,6 +100945,8 @@ components: url: type: string format: uri + user_view_type: + type: string body: type: - string @@ -100188,6 +101245,17 @@ components: format: date-time description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + publicly_leaked: + type: + - boolean + - 'null' + description: Whether the detected secret was publicly leaked. + multi_repo: + type: + - boolean + - 'null' + description: Whether the detected secret was found in multiple repositories + in the same organization or business. webhooks_security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -100347,6 +101415,8 @@ components: type: string url: type: string + user_view_type: + type: string node_id: type: string privacy_level: @@ -100417,6 +101487,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -100486,6 +101558,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -100710,7 +101784,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -100732,7 +101806,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -100756,7 +101830,7 @@ components: rule: "$ref": "#/components/schemas/webhooks_rule" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - rule @@ -100781,7 +101855,7 @@ components: rule: "$ref": "#/components/schemas/webhooks_rule" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - rule @@ -100917,7 +101991,7 @@ components: rule: "$ref": "#/components/schemas/webhooks_rule" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - rule @@ -100940,7 +102014,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - check_run - repository @@ -100973,7 +102047,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - check_run - repository @@ -101014,7 +102088,7 @@ components: user. type: string sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - check_run @@ -101048,7 +102122,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - check_run - repository @@ -101244,6 +102318,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -101675,7 +102751,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - check_suite @@ -101862,6 +102938,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -102291,7 +103369,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - check_suite @@ -102473,6 +103551,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -102901,7 +103981,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - check_suite @@ -102997,6 +104077,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -103152,7 +104234,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -103248,6 +104330,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -103426,7 +104510,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -103588,10 +104672,13 @@ components: - description state: description: State of a code scanning alert. - type: string + type: + - string + - 'null' enum: - open - dismissed + - tool: type: - object @@ -103644,7 +104731,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -103742,6 +104829,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -103922,7 +105011,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -104141,7 +105230,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -104320,7 +105409,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -104338,7 +105427,7 @@ components: enum: - created comment: - description: The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) + description: The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. type: object properties: @@ -104496,6 +105585,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -104522,7 +105613,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - comment @@ -104559,7 +105650,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - ref - ref_type @@ -104585,7 +105676,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - definition @@ -104612,7 +105703,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - definition @@ -104633,7 +105724,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - definition @@ -104654,7 +105745,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" new_property_values: type: array description: The new custom property values for the repository. @@ -104694,7 +105785,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - ref - ref_type @@ -104720,7 +105811,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -104745,7 +105836,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -104770,7 +105861,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -104795,7 +105886,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -104820,7 +105911,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -104845,7 +105936,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -104870,7 +105961,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -104895,7 +105986,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - key @@ -104920,7 +106011,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - key @@ -105007,6 +106098,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -105185,6 +106278,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -105431,7 +106526,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow: "$ref": "#/components/schemas/webhooks_workflow" workflow_run: @@ -105506,6 +106601,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -106001,6 +107098,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -106076,7 +107175,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" webhook-deployment-review-approved: type: object properties: @@ -106099,7 +107198,7 @@ components: reviewers: "$ref": "#/components/schemas/webhooks_reviewers" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" since: type: string workflow_job_run: @@ -106200,6 +107299,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -106351,6 +107452,8 @@ components: type: string url: type: string + user_view_type: + type: string private: type: boolean pulls_url: @@ -106593,6 +107696,8 @@ components: type: string url: type: string + user_view_type: + type: string private: type: boolean pulls_url: @@ -106699,6 +107804,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -106765,7 +107872,7 @@ components: reviewers: "$ref": "#/components/schemas/webhooks_reviewers" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" since: type: string workflow_job_run: @@ -106867,6 +107974,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -107016,6 +108125,8 @@ components: type: string url: type: string + user_view_type: + type: string private: type: boolean pulls_url: @@ -107258,6 +108369,8 @@ components: type: string url: type: string + user_view_type: + type: string private: type: boolean pulls_url: @@ -107363,6 +108476,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -107499,6 +108614,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - id type: @@ -107507,7 +108624,7 @@ components: - User - Team sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" since: type: string workflow_job_run: @@ -107613,6 +108730,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -107762,6 +108881,8 @@ components: type: string url: type: string + user_view_type: + type: string private: type: boolean pulls_url: @@ -108004,6 +109125,8 @@ components: type: string url: type: string + user_view_type: + type: string private: type: boolean pulls_url: @@ -108110,6 +109233,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -108315,6 +109440,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -108497,6 +109624,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -108806,6 +109935,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -108986,6 +110117,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -109223,7 +110356,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow: "$ref": "#/components/schemas/webhooks_workflow" workflow_run: @@ -109298,6 +110431,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -109794,6 +110929,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -109858,7 +110995,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -109928,7 +111065,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -109954,7 +111091,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -109981,7 +111118,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - comment @@ -110009,7 +111146,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - comment @@ -110049,7 +111186,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -110076,7 +111213,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -110101,7 +111238,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -110143,7 +111280,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -110170,7 +111307,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -110196,7 +111333,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -110221,7 +111358,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -110246,7 +111383,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -110281,7 +111418,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -110305,7 +111442,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -110332,7 +111469,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -110358,7 +111495,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -110383,7 +111520,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -110688,6 +111825,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -111078,7 +112217,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - forkee - repository @@ -111092,7 +112231,7 @@ components: enum: - revoked sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - sender @@ -111146,7 +112285,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - pages - repository @@ -111172,7 +112311,7 @@ components: requester: "$ref": "#/components/schemas/webhooks_user" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - installation @@ -111199,7 +112338,7 @@ components: type: - 'null' sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - installation @@ -111226,7 +112365,7 @@ components: type: - 'null' sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - installation @@ -111274,7 +112413,7 @@ components: requester: "$ref": "#/components/schemas/webhooks_user" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - installation @@ -111332,7 +112471,7 @@ components: requester: "$ref": "#/components/schemas/webhooks_user" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - installation @@ -111363,7 +112502,7 @@ components: type: - 'null' sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - installation @@ -111450,6 +112589,8 @@ components: website_url: type: - 'null' + user_view_type: + type: string required: - id - node_id @@ -111485,7 +112626,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" target_type: type: string required: @@ -111516,7 +112657,7 @@ components: type: - 'null' sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - installation @@ -111680,6 +112821,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -111786,6 +112929,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -111858,6 +113003,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -112027,6 +113174,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -112247,6 +113396,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -112599,6 +113750,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -112697,6 +113850,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -112868,7 +114023,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -112975,6 +114130,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -113047,6 +114204,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -113216,6 +114375,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -113434,6 +114595,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -113784,6 +114947,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -113882,6 +115047,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -114043,6 +115210,8 @@ components: type: string url: type: string + user_view_type: + type: string required: - labels - state @@ -114053,7 +115222,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -114162,6 +115331,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -114234,6 +115405,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -114403,6 +115576,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -114623,6 +115798,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -114974,6 +116151,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -115072,6 +116251,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -115243,7 +116424,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -115273,7 +116454,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -115378,6 +116559,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -115450,6 +116633,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -115619,6 +116804,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -115840,6 +117027,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -116191,6 +117380,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -116354,6 +117545,8 @@ components: type: string url: type: string + user_view_type: + type: string required: - state - closed_at @@ -116362,7 +117555,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -116462,6 +117655,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -116701,6 +117896,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -116919,6 +118116,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -117268,6 +118467,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -117298,7 +118499,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -117684,6 +118885,8 @@ components: url: type: string format: uri + user_view_type: + type: string description: type: - string @@ -117894,6 +119097,8 @@ components: url: type: string format: uri + user_view_type: + type: string permissions: description: The set of permissions for the GitHub app type: object @@ -118235,6 +119440,8 @@ components: url: type: string format: uri + user_view_type: + type: string milestone: "$ref": "#/components/schemas/webhooks_milestone" organization: @@ -118242,7 +119449,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -118363,6 +119570,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -118604,6 +119813,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -118824,6 +120035,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -119175,6 +120388,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -119207,7 +120422,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -119309,6 +120524,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -119550,6 +120767,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -119769,6 +120988,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -120120,6 +121341,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -120152,7 +121375,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -120278,6 +121501,8 @@ components: url: type: string format: uri + user_view_type: + type: string assignees: type: array items: @@ -120349,6 +121574,8 @@ components: url: type: string format: uri + user_view_type: + type: string author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -120538,6 +121765,8 @@ components: url: type: string format: uri + user_view_type: + type: string description: type: - string @@ -120750,6 +121979,8 @@ components: url: type: string format: uri + user_view_type: + type: string permissions: description: The set of permissions for the GitHub app type: object @@ -121089,12 +122320,14 @@ components: url: type: string format: uri + user_view_type: + type: string organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -121478,6 +122711,8 @@ components: url: type: string format: uri + user_view_type: + type: string description: type: - string @@ -121689,6 +122924,8 @@ components: url: type: string format: uri + user_view_type: + type: string permissions: description: The set of permissions for the GitHub app type: object @@ -122029,6 +123266,8 @@ components: url: type: string format: uri + user_view_type: + type: string milestone: "$ref": "#/components/schemas/webhooks_milestone" organization: @@ -122036,7 +123275,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -122138,6 +123377,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -122209,6 +123450,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -122377,6 +123620,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -122595,6 +123840,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -122944,6 +124191,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -123267,6 +124516,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -123530,6 +124781,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -123601,6 +124854,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -123770,6 +125025,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -123990,6 +125247,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -124340,6 +125599,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -124370,7 +125631,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -124395,7 +125656,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -124781,6 +126042,8 @@ components: url: type: string format: uri + user_view_type: + type: string description: type: - string @@ -124993,6 +126256,8 @@ components: url: type: string format: uri + user_view_type: + type: string permissions: description: The set of permissions for the GitHub app type: object @@ -125335,12 +126600,14 @@ components: url: type: string format: uri + user_view_type: + type: string organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -125439,6 +126706,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -125510,6 +126779,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -125678,6 +126949,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -125896,6 +127169,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -126245,6 +127520,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -126569,6 +127846,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -126759,7 +128038,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -126788,7 +128067,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -126815,7 +128094,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -126941,6 +128220,8 @@ components: url: type: string format: uri + user_view_type: + type: string assignees: type: array items: @@ -127012,6 +128293,8 @@ components: url: type: string format: uri + user_view_type: + type: string author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -127201,6 +128484,8 @@ components: url: type: string format: uri + user_view_type: + type: string description: type: - string @@ -127411,6 +128696,8 @@ components: url: type: string format: uri + user_view_type: + type: string permissions: description: The set of permissions for the GitHub app type: object @@ -127750,12 +129037,14 @@ components: url: type: string format: uri + user_view_type: + type: string organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -127780,7 +129069,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -127805,7 +129094,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - label @@ -127829,7 +129118,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - label @@ -127885,7 +129174,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - label @@ -127914,7 +129203,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - effective_date @@ -128028,7 +129317,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - effective_date @@ -128140,7 +129429,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - effective_date @@ -128252,7 +129541,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - effective_date @@ -128281,7 +129570,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - effective_date @@ -128333,7 +129622,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - member @@ -128382,7 +129671,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -128408,7 +129697,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - member @@ -128503,6 +129792,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -128605,6 +129896,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -128633,7 +129926,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - merge_group @@ -128662,7 +129955,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - merge_group @@ -128792,7 +130085,7 @@ components: - type: 'null' - "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - hook_id @@ -128816,7 +130109,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - milestone @@ -128841,7 +130134,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - milestone @@ -128866,7 +130159,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - milestone @@ -128922,7 +130215,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -128948,7 +130241,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - milestone @@ -128973,7 +130266,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - blocked_user @@ -128998,7 +130291,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - blocked_user @@ -129023,7 +130316,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - organization @@ -129047,7 +130340,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - membership @@ -129156,6 +130449,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -129188,7 +130483,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" user: "$ref": "#/components/schemas/webhooks_user" required: @@ -129215,7 +130510,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - membership @@ -129248,7 +130543,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - organization @@ -129389,6 +130684,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -129465,6 +130762,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -129775,6 +131074,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -129885,7 +131186,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - package @@ -129991,6 +131292,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -130065,6 +131368,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -130220,6 +131525,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -130334,7 +131641,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - package @@ -130432,6 +131739,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -130462,7 +131771,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - id - build @@ -130483,7 +131792,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" installation: "$ref": "#/components/schemas/simple-installation" required: @@ -130507,7 +131816,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" installation: "$ref": "#/components/schemas/simple-installation" required: @@ -130531,7 +131840,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" installation: "$ref": "#/components/schemas/simple-installation" required: @@ -130554,7 +131863,7 @@ components: enterprise: "$ref": "#/components/schemas/enterprise-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" installation: "$ref": "#/components/schemas/simple-installation" required: @@ -130645,7 +131954,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" zen: description: Random string of GitHub zen. type: string @@ -130690,7 +131999,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -130715,7 +132024,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project_card @@ -130825,6 +132134,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -130863,7 +132174,7 @@ components: - type: 'null' - "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project_card @@ -130901,7 +132212,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -131023,6 +132334,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -131130,7 +132443,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project_card @@ -131154,7 +132467,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project @@ -131178,7 +132491,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project_column @@ -131203,7 +132516,7 @@ components: - type: 'null' - "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project_column @@ -131236,7 +132549,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -131260,7 +132573,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project_column @@ -131284,7 +132597,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project @@ -131310,7 +132623,7 @@ components: - type: 'null' - "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project @@ -131354,7 +132667,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project @@ -131377,7 +132690,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project @@ -131397,7 +132710,7 @@ components: projects_v2: "$ref": "#/components/schemas/projects-v2" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2 @@ -131418,7 +132731,7 @@ components: projects_v2: "$ref": "#/components/schemas/projects-v2" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2 @@ -131439,7 +132752,7 @@ components: projects_v2: "$ref": "#/components/schemas/projects-v2" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2 @@ -131499,7 +132812,7 @@ components: projects_v2: "$ref": "#/components/schemas/projects-v2" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2 @@ -131523,7 +132836,7 @@ components: projects_v2_item: "$ref": "#/components/schemas/projects-v2-item" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_item @@ -131557,7 +132870,7 @@ components: projects_v2_item: "$ref": "#/components/schemas/projects-v2-item" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_item @@ -131579,7 +132892,7 @@ components: projects_v2_item: "$ref": "#/components/schemas/projects-v2-item" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_item @@ -131600,7 +132913,7 @@ components: projects_v2_item: "$ref": "#/components/schemas/projects-v2-item" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_item @@ -131678,7 +132991,7 @@ components: projects_v2_item: "$ref": "#/components/schemas/projects-v2-item" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_item @@ -131713,7 +133026,7 @@ components: projects_v2_item: "$ref": "#/components/schemas/projects-v2-item" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_item @@ -131737,7 +133050,7 @@ components: projects_v2_item: "$ref": "#/components/schemas/projects-v2-item" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_item @@ -131759,7 +133072,7 @@ components: projects_v2: "$ref": "#/components/schemas/projects-v2" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2 @@ -131780,7 +133093,7 @@ components: projects_v2_status_update: "$ref": "#/components/schemas/projects-v2-status-update" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_status_update @@ -131801,7 +133114,7 @@ components: projects_v2_status_update: "$ref": "#/components/schemas/projects-v2-status-update" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_status_update @@ -131887,7 +133200,7 @@ components: projects_v2_status_update: "$ref": "#/components/schemas/projects-v2-status-update" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_status_update @@ -131906,7 +133219,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - repository - sender @@ -132095,6 +133408,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -132167,6 +133482,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -132266,6 +133583,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -132603,6 +133922,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -132713,7 +134034,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -132876,6 +134197,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -133243,6 +134566,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -133353,7 +134678,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -133516,6 +134841,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -133658,6 +134985,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -133745,6 +135074,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -133887,6 +135218,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -134199,6 +135532,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -134242,7 +135577,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -134432,6 +135767,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -134602,6 +135939,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -134939,6 +136278,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -135049,7 +136390,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -135212,6 +136553,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -135575,6 +136918,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -135685,7 +137030,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -135848,6 +137193,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -135990,6 +137337,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -136076,6 +137425,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -136218,6 +137569,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -136530,6 +137883,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -136575,7 +137930,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -136765,6 +138120,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -136935,6 +138292,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -137272,6 +138631,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -137382,7 +138743,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -137545,6 +138906,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -137907,6 +139270,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -138017,7 +139382,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -138180,6 +139545,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -138322,6 +139689,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -138409,6 +139778,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -138551,6 +139922,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -138863,6 +140236,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -138908,7 +140283,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -138936,7 +140311,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -138964,7 +140339,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -138992,7 +140367,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -139180,6 +140555,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -139350,6 +140727,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -139687,6 +141066,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -139797,7 +141178,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -139960,6 +141341,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -140323,6 +141706,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -140433,7 +141818,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -140596,6 +141981,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -140738,6 +142125,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -140825,6 +142214,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -140966,6 +142357,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -141269,6 +142662,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -141311,10 +142706,23 @@ components: - draft reason: type: string + enum: + - UNKNOWN_REMOVAL_REASON + - MANUAL + - MERGE + - MERGE_CONFLICT + - CI_FAILURE + - CI_TIMEOUT + - ALREADY_MERGED + - QUEUE_CLEARED + - ROLL_BACK + - BRANCH_PROTECTIONS + - GIT_TREE_INVALID + - INVALID_MERGE_COMMIT repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -141385,7 +142793,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -141574,6 +142982,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -141744,6 +143154,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -142081,6 +143493,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -142191,7 +143605,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -142354,6 +143768,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -142717,6 +144133,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -142827,7 +144245,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -142990,6 +144408,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -143132,6 +144552,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -143219,6 +144641,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -143360,6 +144784,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -143663,6 +145089,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -143706,7 +145134,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -143898,6 +145326,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -144069,6 +145499,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -144406,6 +145838,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -144516,7 +145950,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -144679,6 +146113,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -145046,6 +146482,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -145156,7 +146594,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -145319,6 +146757,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -145462,6 +146902,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -145549,6 +146991,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -145691,6 +147135,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -146003,6 +147449,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -146046,7 +147494,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -146235,6 +147683,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -146406,6 +147856,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -146743,6 +148195,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -146853,7 +148307,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -147016,6 +148470,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -147383,6 +148839,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -147493,7 +148951,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -147656,6 +149114,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -147799,6 +149259,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -147885,6 +149347,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -148027,6 +149491,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -148339,6 +149805,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -148382,7 +149850,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -148410,7 +149878,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -148437,7 +149905,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -148465,7 +149933,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -148493,7 +149961,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -148769,6 +150237,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -148968,6 +150438,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -149139,6 +150611,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -149476,6 +150950,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -149586,7 +151062,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -149749,6 +151225,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -150103,6 +151581,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -150213,7 +151693,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -150375,6 +151855,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -150521,6 +152003,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -150657,6 +152141,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -150964,6 +152450,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -151005,7 +152493,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - comment @@ -151191,6 +152679,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -151361,6 +152851,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -151698,6 +153190,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -151808,7 +153302,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -151971,6 +153465,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -152325,6 +153821,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -152435,7 +153933,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -152598,6 +154096,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -152743,6 +154243,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -152878,6 +154380,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -153176,6 +154680,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -153217,7 +154723,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - comment @@ -153405,6 +154911,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -153476,6 +154984,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -153575,6 +155085,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -153912,6 +155424,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -154022,7 +155536,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -154185,6 +155699,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -154539,6 +156055,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -154649,7 +156167,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -154812,6 +156330,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -154958,6 +156478,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -155093,6 +156615,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -155388,6 +156912,8 @@ components: - User - Organization - Mannequin + user_view_type: + type: string url: type: string format: uri @@ -155432,7 +156958,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -155619,6 +157145,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -155790,6 +157318,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -156127,6 +157657,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -156237,7 +157769,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -156400,6 +157932,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -156754,6 +158288,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -156864,7 +158400,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -157027,6 +158563,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -157172,6 +158710,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -157308,6 +158848,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -157615,6 +159157,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -157794,6 +159338,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -157810,7 +159356,7 @@ components: - author_association - _links sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - review @@ -158008,6 +159554,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -158179,6 +159727,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -158490,6 +160040,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -158730,6 +160282,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -159058,6 +160612,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -159298,6 +160854,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -159444,6 +161002,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -159580,6 +161140,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -159887,6 +161449,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -159932,7 +161496,7 @@ components: review: "$ref": "#/components/schemas/webhooks_review" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -160124,6 +161688,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -160195,6 +161761,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -160294,6 +161862,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -160631,6 +162201,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -160732,7 +162304,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -160895,6 +162467,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -161258,6 +162832,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -161368,7 +162944,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -161531,6 +163107,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -161673,6 +163251,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -161759,6 +163339,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -161900,6 +163482,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -162221,6 +163805,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -162329,11 +163915,13 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - requested_reviewer - action @@ -162522,6 +164110,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -162593,6 +164183,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -162692,6 +164284,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -163029,6 +164623,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -163139,7 +164735,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -163302,6 +164898,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -163665,6 +165263,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -163775,7 +165375,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -163938,6 +165538,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -164080,6 +165682,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -164166,6 +165770,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -164307,6 +165913,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -164628,6 +166236,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -164782,7 +166392,7 @@ components: - repositories_url - permission sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - requested_team - action @@ -164975,6 +166585,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -165047,6 +166659,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -165146,6 +166760,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -165483,6 +167099,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -165593,7 +167211,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -165756,6 +167374,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -166119,6 +167739,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -166229,7 +167851,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -166392,6 +168014,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -166534,6 +168158,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -166621,6 +168247,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -166762,6 +168390,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -167075,6 +168705,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -167184,11 +168816,13 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - requested_reviewer - action @@ -167378,6 +169012,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -167450,6 +169086,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -167549,6 +169187,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -167886,6 +169526,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -167996,7 +169638,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -168159,6 +169801,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -168522,6 +170166,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -168632,7 +170278,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -168795,6 +170441,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -168937,6 +170585,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -169024,6 +170674,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -169165,6 +170817,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -169469,6 +171123,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -169614,7 +171270,7 @@ components: - name - id sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - requested_team - action @@ -169801,6 +171457,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -169972,6 +171630,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -170309,6 +171969,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -170419,7 +172081,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -170582,6 +172244,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -170938,6 +172602,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -171048,7 +172714,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -171211,6 +172877,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -171357,6 +173025,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -171493,6 +173163,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -171800,6 +173472,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -171845,7 +173519,7 @@ components: review: "$ref": "#/components/schemas/webhooks_review" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - review @@ -172030,6 +173704,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -172200,6 +173876,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -172515,6 +174193,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -172760,6 +174440,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -173094,6 +174776,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -173339,6 +175023,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -173484,6 +175170,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -173620,6 +175308,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -173927,6 +175617,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -173970,7 +175662,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" thread: type: object properties: @@ -174240,6 +175932,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -174457,6 +176151,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -174625,6 +176321,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -174940,6 +176638,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -175185,6 +176885,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -175515,6 +177217,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -175760,6 +177464,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -175905,6 +177611,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -176040,6 +177748,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -176337,6 +178047,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -176380,7 +178092,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" thread: type: object properties: @@ -176647,6 +178359,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -176873,6 +178587,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -177044,6 +178760,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -177381,6 +179099,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -177491,7 +179211,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -177654,6 +179374,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -178008,6 +179730,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -178118,7 +179842,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -178281,6 +180005,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -178423,6 +180149,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -178510,6 +180238,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -178652,6 +180382,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -178964,6 +180696,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -179007,7 +180741,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -179201,6 +180935,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -179372,6 +181108,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -179711,6 +181449,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -179821,7 +181561,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -179984,6 +181724,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -180351,6 +182093,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -180461,7 +182205,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -180624,6 +182368,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -180767,6 +182513,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -180854,6 +182602,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -180996,6 +182746,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -181308,6 +183060,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -181351,7 +183105,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -181542,6 +183296,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -181713,6 +183469,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -182050,6 +183808,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -182160,7 +183920,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -182323,6 +184083,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -182681,6 +184443,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -182791,7 +184555,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -182954,6 +184718,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -183096,6 +184862,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -183183,6 +184951,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -183325,6 +185095,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -183637,6 +185409,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -183680,7 +185454,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -183869,6 +185643,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -184037,6 +185813,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -184374,6 +186152,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -184484,7 +186264,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -184647,6 +186427,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -185012,6 +186794,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -185122,7 +186906,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -185285,6 +187069,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -185427,6 +187213,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -185513,6 +187301,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -185654,6 +187444,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -185956,6 +187748,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -185999,7 +187793,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -186553,6 +188347,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -186730,7 +188526,7 @@ components: - topics - visibility sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - ref - before @@ -186817,6 +188613,8 @@ components: type: string url: type: string + user_view_type: + type: string required: - login - id @@ -186882,6 +188680,8 @@ components: type: string url: type: string + user_view_type: + type: string required: - login - id @@ -187203,6 +189003,8 @@ components: type: string url: type: string + user_view_type: + type: string created_at: type: string draft: @@ -187287,7 +189089,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - registry_package @@ -187362,6 +189164,8 @@ components: type: string url: type: string + user_view_type: + type: string required: - login - id @@ -187425,6 +189229,8 @@ components: type: string url: type: string + user_view_type: + type: string required: - login - id @@ -187557,6 +189363,8 @@ components: type: string url: type: string + user_view_type: + type: string required: - login - id @@ -187664,7 +189472,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - registry_package @@ -187688,7 +189496,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - release @@ -187713,7 +189521,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - release @@ -187768,7 +189576,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -188010,6 +189818,8 @@ components: url: type: string format: uri + user_view_type: + type: string body: type: - string @@ -188109,7 +189919,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - release @@ -188133,7 +189943,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - release @@ -188157,7 +189967,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - release @@ -188181,7 +189991,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - release @@ -188205,7 +190015,7 @@ components: repository_advisory: "$ref": "#/components/schemas/repository-advisory" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -188229,7 +190039,7 @@ components: repository_advisory: "$ref": "#/components/schemas/repository-advisory" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -188251,7 +190061,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -188273,7 +190083,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -188295,7 +190105,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -188326,7 +190136,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - branch @@ -188388,7 +190198,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -188407,7 +190217,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" status: type: string enum: @@ -188435,7 +190245,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -188457,7 +190267,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -188496,7 +190306,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -188521,7 +190331,7 @@ components: repository_ruleset: "$ref": "#/components/schemas/repository-ruleset" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository_ruleset @@ -188545,7 +190355,7 @@ components: repository_ruleset: "$ref": "#/components/schemas/repository-ruleset" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository_ruleset @@ -188663,7 +190473,7 @@ components: from: type: string sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository_ruleset @@ -188806,6 +190616,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -188822,7 +190634,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -188845,7 +190657,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -188869,7 +190681,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -188986,6 +190798,8 @@ components: url: type: string format: uri + user_view_type: + type: string external_identifier: type: string external_reference: @@ -189023,7 +190837,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -189048,7 +190862,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -189196,7 +191010,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -189221,7 +191035,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -189245,7 +191059,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - location - alert @@ -189261,6 +191075,30 @@ components: type: string required: - payload + webhook-secret-scanning-alert-publicly-leaked: + title: secret_scanning_alert publicly leaked event + type: object + properties: + action: + type: string + enum: + - publicly_leaked + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-reopened: title: secret_scanning_alert reopened event type: object @@ -189280,7 +191118,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -189304,7 +191142,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -189328,7 +191166,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -189352,7 +191190,7 @@ components: security_advisory: "$ref": "#/components/schemas/webhooks_security_advisory" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - security_advisory @@ -189375,7 +191213,7 @@ components: security_advisory: "$ref": "#/components/schemas/webhooks_security_advisory" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - security_advisory @@ -189509,7 +191347,7 @@ components: - withdrawn_at - vulnerabilities sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - security_advisory @@ -189534,7 +191372,7 @@ components: repository: "$ref": "#/components/schemas/full-repository" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - changes - repository @@ -189555,7 +191393,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" sponsorship: "$ref": "#/components/schemas/webhooks_sponsorship" required: @@ -189579,7 +191417,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" sponsorship: "$ref": "#/components/schemas/webhooks_sponsorship" required: @@ -189615,7 +191453,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" sponsorship: "$ref": "#/components/schemas/webhooks_sponsorship" required: @@ -189642,7 +191480,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" sponsorship: "$ref": "#/components/schemas/webhooks_sponsorship" required: @@ -189670,7 +191508,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" sponsorship: "$ref": "#/components/schemas/webhooks_sponsorship" required: @@ -189697,7 +191535,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" sponsorship: "$ref": "#/components/schemas/webhooks_sponsorship" required: @@ -189722,7 +191560,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" starred_at: description: 'The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` @@ -189752,7 +191590,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" starred_at: description: 'The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` @@ -190131,7 +191969,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" sha: description: The Commit SHA. type: string @@ -190191,7 +192029,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - parent_issue_id @@ -190226,7 +192064,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - parent_issue_id @@ -190261,7 +192099,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - sub_issue_id @@ -190296,7 +192134,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - sub_issue_id @@ -190317,7 +192155,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" team: "$ref": "#/components/schemas/webhooks_team_1" required: @@ -190633,6 +192471,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -190805,7 +192645,7 @@ components: - topics - visibility sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" team: "$ref": "#/components/schemas/webhooks_team_1" required: @@ -191121,6 +192961,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -191293,7 +193135,7 @@ components: - topics - visibility sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" team: "$ref": "#/components/schemas/webhooks_team_1" required: @@ -191610,6 +193452,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -191782,7 +193626,7 @@ components: - topics - visibility sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" team: "$ref": "#/components/schemas/webhooks_team_1" required: @@ -192163,6 +194007,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -192335,7 +194181,7 @@ components: - topics - visibility sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" team: "$ref": "#/components/schemas/webhooks_team_1" required: @@ -192653,6 +194499,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -192825,7 +194673,7 @@ components: - topics - visibility sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" team: "$ref": "#/components/schemas/webhooks_team_1" required: @@ -192850,7 +194698,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -192875,7 +194723,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow: type: string required: @@ -192901,7 +194749,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow_job: allOf: - title: Workflow Job @@ -193176,7 +195024,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow_job: allOf: - title: Workflow Job @@ -193477,7 +195325,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow_job: type: object properties: @@ -193646,7 +195494,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow_job: type: object properties: @@ -193816,7 +195664,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow: "$ref": "#/components/schemas/webhooks_workflow" workflow_run: @@ -193926,6 +195774,8 @@ components: url: type: string format: uri + user_view_type: + type: string artifacts_url: type: string format: uri @@ -194244,6 +196094,8 @@ components: url: type: string format: uri + user_view_type: + type: string private: description: Whether the repository is private or public. type: boolean @@ -194611,6 +196463,8 @@ components: url: type: string format: uri + user_view_type: + type: string private: description: Whether the repository is private or public. type: boolean @@ -194732,6 +196586,8 @@ components: url: type: string format: uri + user_view_type: + type: string updated_at: type: string format: date-time @@ -194772,7 +196628,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow: "$ref": "#/components/schemas/webhooks_workflow" workflow_run: @@ -195722,7 +197578,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow: "$ref": "#/components/schemas/webhooks_workflow" workflow_run: @@ -195795,6 +197651,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -196066,6 +197924,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -196431,6 +198291,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -196599,6 +198461,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -199458,6 +201322,7 @@ components: pending_cancellation_date: last_activity_at: '2021-10-14T00:53:32-06:00' last_activity_editor: vscode/1.77.3/copilot/1.86.82 + plan_type: business assignee: login: octocat id: 1 @@ -199515,6 +201380,105 @@ components: received_events_url: https://api.github.com/users/octokitten/received_events type: User site_admin: false + copilot-usage-metrics-for-day: + value: + - date: '2024-06-24' + total_active_users: 24 + total_engaged_users: 20 + copilot_ide_code_completions: + total_engaged_users: 20 + languages: + - name: python + total_engaged_users: 10 + - name: ruby + total_engaged_users: 10 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 13 + languages: + - name: python + total_engaged_users: 6 + total_code_suggestions: 249 + total_code_acceptances: 123 + total_code_lines_suggested: 225 + total_code_lines_accepted: 135 + - name: ruby + total_engaged_users: 7 + total_code_suggestions: 496 + total_code_acceptances: 253 + total_code_lines_suggested: 520 + total_code_lines_accepted: 270 + - name: neovim + total_engaged_users: 7 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + languages: + - name: typescript + total_engaged_users: 3 + total_code_suggestions: 112 + total_code_acceptances: 56 + total_code_lines_suggested: 143 + total_code_lines_accepted: 61 + - name: go + total_engaged_users: 4 + total_code_suggestions: 132 + total_code_acceptances: 67 + total_code_lines_suggested: 154 + total_code_lines_accepted: 72 + copilot_ide_chat: + total_engaged_users: 13 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 12 + total_chats: 45 + total_chat_insertion_events: 12 + total_chat_copy_events: 16 + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_engaged_users: 1 + total_chats: 10 + total_chat_insertion_events: 11 + total_chat_copy_events: 3 + copilot_dotcom_chat: + total_engaged_users: 14 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 14 + total_chats: 38 + copilot_dotcom_pull_requests: + total_engaged_users: 12 + repositories: + - name: demo/repo1 + total_engaged_users: 8 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_pr_summaries_created: 6 + total_engaged_users: 8 + - name: demo/repo2 + total_engaged_users: 4 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_pr_summaries_created: 10 + total_engaged_users: 4 copilot-usage-metrics-enterprise: value: - day: '2023-10-15' @@ -200010,6 +201974,8 @@ components: push_protection_bypassed_at: '2020-11-06T21:48:51Z' resolution_comment: Example comment validity: active + publicly_leaked: false + multi_repo: false - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -200092,6 +202058,8 @@ components: push_protection_bypassed_at: resolution_comment: validity: unknown + publicly_leaked: false + multi_repo: false copilot-usage-metrics-org: value: - day: '2023-10-15' @@ -200304,6 +202272,7 @@ components: size: 23 truncated: false content: Hello world from GitHub + encoding: utf-8 public: true created_at: '2022-09-20T12:11:58Z' updated_at: '2022-09-21T10:28:06Z' @@ -201616,6 +203585,7 @@ components: members_can_fork_private_repositories: false web_commit_signoff_required: false updated_at: '2014-03-03T18:58:10Z' + deploy_keys_enabled_for_repositories: false dependency_graph_enabled_for_new_repositories: false dependabot_alerts_enabled_for_new_repositories: false dependabot_security_updates_enabled_for_new_repositories: false @@ -201781,6 +203751,309 @@ components: value: default_workflow_permissions: read can_approve_pull_request_reviews: true + runner-groups-org: + value: + total_count: 3 + runner_groups: + - id: 1 + name: Default + visibility: all + default: true + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners + inherited: false + allows_public_repositories: true + restricted_to_workflows: false + selected_workflows: [] + workflow_restrictions_read_only: false + - id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + inherited: true + allows_public_repositories: true + restricted_to_workflows: true + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: true + - id: 3 + name: expensive-hardware + visibility: private + default: false + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners + inherited: false + allows_public_repositories: true + restricted_to_workflows: false + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: false + runner-group: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + hosted_runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners + network_configuration_id: EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA + inherited: false + allows_public_repositories: true + restricted_to_workflows: true + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: false + runner-group-item: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + hosted_runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners + network_configuration_id: EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA + inherited: false + allows_public_repositories: true + restricted_to_workflows: true + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: false + minimal-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + organization: + language: + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + delete_branch_on_merge: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + forks: 1 + open_issues: 1 + watchers: 1 runner-paginated: value: total_count: 2 @@ -202401,6 +204674,12 @@ components: code_scanning_default_setup: enabled secret_scanning: enabled secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: enabled + secret_scanning_delegated_bypass_options: + reviewers: + - security_configuration_id: 17 + reviewer_id: 5678 + reviewer_type: TEAM secret_scanning_validity_checks: enabled secret_scanning_non_provider_patterns: enabled private_vulnerability_reporting: enabled @@ -202424,6 +204703,7 @@ components: code_scanning_default_setup: enabled secret_scanning: enabled secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled secret_scanning_validity_checks: disabled secret_scanning_non_provider_patterns: disabled private_vulnerability_reporting: enabled @@ -202448,6 +204728,7 @@ components: code_scanning_default_setup: disabled secret_scanning: enabled secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled secret_scanning_validity_checks: disabled secret_scanning_non_provider_patterns: disabled private_vulnerability_reporting: disabled @@ -202474,6 +204755,12 @@ components: code_scanning_default_setup: enabled secret_scanning: enabled secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: enabled + secret_scanning_delegated_bypass_options: + reviewers: + - security_configuration_id: 1325 + reviewer_id: 5678 + reviewer_type: TEAM secret_scanning_validity_checks: enabled secret_scanning_non_provider_patterns: enabled private_vulnerability_reporting: enabled @@ -202499,6 +204786,7 @@ components: code_scanning_default_setup: enabled secret_scanning: enabled secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled secret_scanning_validity_checks: disabled private_vulnerability_reporting: enabled enforcement: enforced @@ -202522,6 +204810,7 @@ components: code_scanning_default_setup: enabled secret_scanning: disabled secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled secret_scanning_validity_checks: disabled secret_scanning_non_provider_patterns: disabled private_vulnerability_reporting: disabled @@ -203039,7 +205328,11 @@ components: active_this_cycle: 12 inactive_this_cycle: 11 seat_management_setting: assign_selected + ide_chat: enabled + platform_chat: enabled + cli: enabled public_code_suggestions: block + plan_type: business organization-dependabot-secret-paginated: value: total_count: 3 @@ -203257,6 +205550,58 @@ components: updated_at: '2011-09-06T20:39:23Z' created_at: '2011-09-06T17:26:27Z' type: Organization + api-insights-route-stats: + value: + - http_method: GET + api_route: "/repositories/:repository_id" + total_request_count: 544665 + rate_limited_request_count: 13 + last_request_timestamp: '2024-09-18T15:43:03Z' + last_rate_limited_timestamp: '2024-09-18T06:30:09Z' + api-insights-subject-stats: + value: + - subject_type: installation + subject_id: 954453 + subject_name: GitHub Actions + integration_id: 124345 + total_request_count: 544665 + rate_limited_request_count: 13 + last_request_timestamp: '2024-09-18T15:43:03Z' + last_rate_limited_timestamp: '2024-09-18T06:30:09Z' + api-insights-summary-stats: + value: + total_request_count: 34225 + rate_limited_request_count: 23 + api-insights-time-stats: + value: + - timestamp: '2024-09-11T15:00:00Z' + total_request_count: 34225 + rate_limited_request_count: 0 + - timestamp: '2024-09-11T15:05:00Z' + total_request_count: 10587 + rate_limited_request_count: 18 + - timestamp: '2024-09-11T15:10:00Z' + total_request_count: 43587 + rate_limited_request_count: 14 + - timestamp: '2024-09-11T15:15:00Z' + total_request_count: 19463 + rate_limited_request_count: 4 + - timestamp: '2024-09-11T15:20:00Z' + total_request_count: 60542 + rate_limited_request_count: 3 + - timestamp: '2024-09-11T15:25:00Z' + total_request_count: 55872 + rate_limited_request_count: 23 + api-insights-user-stats: + value: + - actor_type: oauth_app + actor_id: 954453 + actor_name: GitHub Actions + oauth_application_id: 1245 + total_request_count: 544665 + rate_limited_request_count: 13 + last_request_timestamp: '2024-09-18T15:43:03Z' + last_rate_limited_timestamp: '2024-09-18T06:30:09Z' installation: value: id: 1 @@ -203551,6 +205896,7 @@ components: pending_cancellation_date: last_activity_at: '2021-10-14T00:53:32-06:00' last_activity_editor: vscode/1.77.3/copilot/1.86.82 + plan_type: business assignee: login: octocat id: 1 @@ -204362,6 +206708,8 @@ components: repository: metadata: read created_at: '2023-05-16T08:47:09.000-07:00' + token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -204395,6 +206743,8 @@ components: repository: metadata: read access_granted_at: '2023-05-16T08:47:09.000-07:00' + token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -205081,7 +207431,7 @@ components: value: - id: 21 actor_id: 12 - username: octocat + actor_name: octocat before_sha: 893f768e172fb1bc9c5d6f3dd48557e45f14e01d after_sha: dedd88641a362b6b4ea872da4847d6131a164d01 ref: refs/heads/i-see-everything @@ -205091,7 +207441,7 @@ components: result: bypass - id: 25 actor_id: 11 - username: not-octocat + actor_name: not-octocat before_sha: 48994e4e01ccc943624c6231f172702b82b233cc after_sha: ecfd5a1025fa271a33ca5608d089476a2df3c9a1 ref: refs/heads/i-am-everything @@ -205104,7 +207454,7 @@ components: value: id: 21 actor_id: 12 - username: octocat + actor_name: octocat before_sha: 893f768e172fb1bc9c5d6f3dd48557e45f14e01d after_sha: dedd88641a362b6b4ea872da4847d6131a164d01 ref: refs/heads/i-see-everything @@ -209965,7 +212315,7 @@ components: analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 code-security-configuration-for-repository: value: - state: attached + status: attached configuration: id: 1325 target_type: organization @@ -209981,6 +212331,7 @@ components: code_scanning_default_setup: disabled secret_scanning: enabled secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled secret_scanning_validity_checks: disabled secret_scanning_non_provider_patterns: disabled private_vulnerability_reporting: disabled @@ -212482,18 +214833,36 @@ components: - 'Tool: GitHub.com-Dependency-Graph' name: github/example dataLicense: CC0-1.0 - documentDescribes: - - github/example - documentNamespace: https://github.com/github/example/dependency_graph/sbom-abcdef123456 + documentNamespace: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: - - SPDXID: SPDXRef-Package - name: rubygems:rails + - name: rails + SPDXID: SPDXRef-Package versionInfo: 1.0.0 downloadLocation: NOASSERTION filesAnalyzed: false licenseConcluded: MIT licenseDeclared: MIT copyrightText: Copyright (c) 1985 GitHub.com + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:gem/rails@1.0.0 + - name: github/example + SPDXID: SPDXRef-Repository + versionInfo: main + downloadLocation: NOASSERTION + filesAnalyzed: false + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:github/example@main + relationships: + - relationshipType: DEPENDS_ON + spdxElementId: SPDXRef-Repository + relatedSpdxElement: SPDXRef-Package + - relationshipType: DESCRIBES + spdxElementId: SPDXRef-DOCUMENT + relatedSpdxElement: SPDXRef-Repository dependency-graph-create-snapshot-request: value: version: 0 @@ -214496,6 +216865,7 @@ components: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true deploy-key: value: id: 1 @@ -214507,6 +216877,7 @@ components: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true label: value: id: 208045946 @@ -217206,6 +219577,8 @@ components: push_protection_bypassed_at: '2020-11-06T21:48:51Z' resolution_comment: Example comment validity: inactive + publicly_leaked: false + multi_repo: false - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -217223,6 +219596,8 @@ components: push_protection_bypassed_at: resolution_comment: validity: unknown + publicly_leaked: false + multi_repo: false secret-scanning-alert-open: value: number: 42 @@ -217242,6 +219617,8 @@ components: push_protection_bypassed_at: resolution_comment: validity: unknown + publicly_leaked: false + multi_repo: false secret-scanning-alert-resolved: value: number: 42 @@ -217279,6 +219656,8 @@ components: push_protection_bypassed_at: resolution_comment: Example comment validity: unknown + publicly_leaked: false + multi_repo: false secret-scanning-location-list: value: - type: commit @@ -219169,240 +221548,6 @@ components: updated_at: '2020-01-10T14:59:22Z' visibility: selected selected_repositories_url: https://api.github.com/user/codespaces/secrets/CODESPACE_GH_SECRET/repositories - minimal-repository-paginated: - value: - total_count: 1 - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - template_repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - organization: - language: - forks: 9 - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues: 0 - open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - delete_branch_on_merge: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - forks: 1 - open_issues: 1 - watchers: 1 user-export-details: value: state: succeeded @@ -223129,6 +225274,8 @@ components: resolved_by: secret_type: mailchimp_api_key secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 + publicly_leaked: false + multi_repo: false location: type: commit details: @@ -223515,6 +225662,31 @@ components: required: false schema: type: string + secret-scanning-alert-publicly-leaked: + name: is_publicly_leaked + in: query + description: A boolean value representing whether or not to filter alerts by + the publicly-leaked tag being present. + required: false + schema: + type: boolean + default: false + secret-scanning-alert-multi-repo: + name: is_multi_repo + in: query + description: A boolean value representing whether or not to filter alerts by + the multi-repo tag being present. + required: false + schema: + type: boolean + default: false + enterprise-team-slug: + name: team_slug + description: The slug of the enterprise team name. + in: path + required: true + schema: + type: string team-slug: name: team_slug description: The slug of the team name. @@ -223642,6 +225814,20 @@ components: required: true schema: type: integer + visible-to-repository: + name: visible_to_repository + description: Only return runner groups that are allowed to be used by this repository. + in: query + required: false + schema: + type: string + runner-group-id: + name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer runner-id: name: runner_id description: Unique identifier of the self-hosted runner. @@ -223719,6 +225905,88 @@ components: required: true schema: type: integer + api-insights-actor-type: + name: actor_type + in: path + description: The type of the actor + required: true + schema: + type: string + enum: + - installations + - classic_pats + - fine_grained_pats + - oauth_apps + - github_apps_user_to_server + api-insights-actor-id: + name: actor_id + in: path + description: The ID of the actor + required: true + schema: + type: integer + api-insights-min-timestamp: + name: min_timestamp + description: The minimum timestamp to query for stats + in: query + required: true + schema: + type: string + api-insights-max-timestamp: + name: max_timestamp + description: The maximum timestamp to query for stats + in: query + required: true + schema: + type: string + api-insights-route-stats-sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: array + items: + type: string + enum: + - last_rate_limited_timestamp + - last_request_timestamp + - rate_limited_request_count + - http_method + - api_route + - total_request_count + default: total_request_count + api-insights-sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: array + items: + type: string + enum: + - last_rate_limited_timestamp + - last_request_timestamp + - rate_limited_request_count + - subject_name + - total_request_count + default: total_request_count + api-insights-user-id: + name: user_id + in: path + description: The ID of the user to query for stats + required: true + schema: + type: string + api-insights-timestamp-increment: + name: timestamp_increment + description: The increment of time used to breakdown the query results (5m, + 10m, 1h, etc.) + in: query + required: true + schema: + type: string invitation-id: name: invitation_id description: The unique identifier of the invitation. @@ -223870,11 +226138,23 @@ components: type: integer custom-property-name: name: custom_property_name - description: The custom property name. The name is case sensitive. + description: The custom property name in: path required: true schema: type: string + ruleset-targets: + name: targets + description: | + A comma-separated list of rule targets to filter by. + If provided, only rulesets that apply to the specified targets will be returned. + For example, `branch,tag,push`. + in: query + required: false + schema: + type: string + examples: + - branch,tag,push ref-in-query: name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally @@ -224256,6 +226536,13 @@ components: required: false schema: "$ref": "#/components/schemas/code-scanning-ref" + pr-alias: + name: pr + description: The number of the pull request for the results you want to list. + in: query + required: false + schema: + type: integer alert-number: name: alert_number in: path @@ -224577,6 +226864,13 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + usage_metrics_api_disabled: + description: Copilot Usage Merics API setting is disabled at the organization + or enterprise level. + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" service_unavailable: description: Service unavailable content: diff --git a/packages/openapi-typescript/examples/github-api-required.ts b/packages/openapi-typescript/examples/github-api-required.ts index 5657f019a..140ff6084 100644 --- a/packages/openapi-typescript/examples/github-api-required.ts +++ b/packages/openapi-typescript/examples/github-api-required.ts @@ -453,7 +453,7 @@ export interface paths { * List accepted assignments for an assignment * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ - get: operations["classroom/list-accepted-assigments-for-an-assignment"]; + get: operations["classroom/list-accepted-assignments-for-an-assignment"]; put?: never; post?: never; delete?: never; @@ -612,13 +612,16 @@ export interface paths { /** * List all Copilot seat assignments for an enterprise * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + * Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. * * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. * * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + * telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + * see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. * @@ -633,6 +636,35 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for an enterprise + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/enterprises/{enterprise}/copilot/usage": { parameters: { query?: never; @@ -643,7 +675,7 @@ export interface paths { /** * Get a summary of Copilot usage for enterprise members * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -653,6 +685,8 @@ export interface paths { * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * + * The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + * * Only owners and billing managers can view Copilot usage metrics for the enterprise. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -718,6 +752,38 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for an enterprise team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-enterprise-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { parameters: { query?: never; @@ -728,7 +794,7 @@ export interface paths { /** * Get a summary of Copilot usage for an enterprise team * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -1609,10 +1675,10 @@ export interface paths { /** * Update an organization * @description > [!WARNING] - * > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * > **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * > [!WARNING] - * > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * * Updates the organization's profile and member privileges. * @@ -1842,6 +1908,180 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List self-hosted runner groups for an organization + * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-self-hosted-runner-groups-for-org"]; + put?: never; + /** + * Create a self-hosted runner group for an organization + * @description Creates a new self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["actions/create-self-hosted-runner-group-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a self-hosted runner group for an organization + * @description Gets a specific self-hosted runner group for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/get-self-hosted-runner-group-for-org"]; + put?: never; + post?: never; + /** + * Delete a self-hosted runner group from an organization + * @description Deletes a self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + options?: never; + head?: never; + /** + * Update a self-hosted runner group for an organization + * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + patch: operations["actions/update-self-hosted-runner-group-for-org"]; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List repository access to a self-hosted runner group in an organization + * @description Lists the repositories with access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; + /** + * Set repository access for a self-hosted runner group in an organization + * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Add repository access to a self-hosted runner group in an organization + * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; + /** + * Remove repository access to a self-hosted runner group in an organization + * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List self-hosted runners in a group for an organization + * @description Lists self-hosted runners that are in a specific organization group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-self-hosted-runners-in-group-for-org"]; + /** + * Set self-hosted runners in a group for an organization + * @description Replaces the list of self-hosted runners that are part of an organization runner group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Add a self-hosted runner to a group for an organization + * @description Adds a self-hosted runner to a runner group configured in an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + post?: never; + /** + * Remove a self-hosted runner from a group for an organization + * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/runners": { parameters: { query?: never; @@ -2912,11 +3152,11 @@ export interface paths { /** * Get Copilot seat information and settings for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Gets information about an organization's Copilot subscription, including seat breakdown * and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." * * Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. * @@ -2941,11 +3181,14 @@ export interface paths { /** * List all Copilot seat assignments for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + * Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. * Only organization owners can view assigned seats. * + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/list-copilot-seats"]; @@ -2969,16 +3212,16 @@ export interface paths { /** * Add teams to the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * * Only organization owners can add Copilot seats for their organization members. * * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * * The response will contain the total number of new seats that were created and existing seats that were refreshed. * @@ -2988,17 +3231,19 @@ export interface paths { /** * Remove teams from the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Cancels the Copilot seat assignment for all members of each team specified. - * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Sets seats for all members of each team specified to "pending cancellation". + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * + * The response will contain the total number of seats set to "pending cancellation". + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; @@ -3019,16 +3264,16 @@ export interface paths { /** * Add users to the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * * Only organization owners can add Copilot seats for their organization members. * * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * * The response will contain the total number of new seats that were created and existing seats that were refreshed. * @@ -3038,17 +3283,19 @@ export interface paths { /** * Remove users from the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Cancels the Copilot seat assignment for each user specified. - * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Sets seats for all users specified to "pending cancellation". + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * + * The response will contain the total number of seats set to "pending cancellation". + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; @@ -3057,6 +3304,38 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for an organization + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + * Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/copilot/usage": { parameters: { query?: never; @@ -3067,7 +3346,7 @@ export interface paths { /** * Get a summary of Copilot usage for organization members * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -3534,6 +3813,186 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get route stats by actor + * @description Get API request count statistics for an actor broken down by route within a specified time frame. + */ + get: operations["api-insights/get-route-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/subject-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get subject stats + * @description Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + */ + get: operations["api-insights/get-subject-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/summary-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get summary stats + * @description Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + */ + get: operations["api-insights/get-summary-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get summary stats by user + * @description Get overall statistics of API requests within the organization for a user. + */ + get: operations["api-insights/get-summary-stats-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get summary stats by actor + * @description Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + */ + get: operations["api-insights/get-summary-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/time-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get time stats + * @description Get the number of API requests and rate-limited requests made within an organization over a specified time period. + */ + get: operations["api-insights/get-time-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/time-stats/users/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get time stats by user + * @description Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + */ + get: operations["api-insights/get-time-stats-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get time stats by actor + * @description Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + */ + get: operations["api-insights/get-time-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/user-stats/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get user stats + * @description Get API usage statistics within an organization for a user broken down by the type of access. + */ + get: operations["api-insights/get-user-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/installation": { parameters: { query?: never; @@ -3831,9 +4290,12 @@ export interface paths { /** * Get Copilot seat assignment details for a user * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + * + * The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * * Only organization owners can view Copilot seat assignment details for members of their organization. * @@ -4272,7 +4734,7 @@ export interface paths { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; put?: never; @@ -4294,7 +4756,7 @@ export interface paths { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; put?: never; @@ -4305,7 +4767,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; options?: never; @@ -4332,7 +4794,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; delete?: never; @@ -4352,7 +4814,7 @@ export interface paths { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; put?: never; @@ -4374,7 +4836,7 @@ export interface paths { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; put?: never; @@ -4385,7 +4847,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; options?: never; @@ -4412,7 +4874,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; delete?: never; @@ -5041,6 +5503,38 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for a team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + * Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/team/{team_slug}/copilot/usage": { parameters: { query?: never; @@ -5051,7 +5545,7 @@ export interface paths { /** * Get a summary of Copilot usage for a team * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -5689,7 +6183,7 @@ export interface paths { * Enable or disable a security feature for an organization * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). * * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -5949,7 +6443,7 @@ export interface paths { * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." * * > [!NOTE] - * > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; put?: never; @@ -8355,7 +8849,7 @@ export interface paths { * and `0` is returned in this field. * * > [!WARNING] - * > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -8482,7 +8976,7 @@ export interface paths { * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-codeql-databases"]; put?: never; @@ -8510,12 +9004,18 @@ export interface paths { * your HTTP client is configured to follow redirects or use the `Location` header * to make a second request to get the redirect URL. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-codeql-database"]; put?: never; post?: never; - delete?: never; + /** + * Delete a CodeQL database + * @description Deletes a CodeQL database for a language in a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + delete: operations["code-scanning/delete-codeql-database"]; options?: never; head?: never; patch?: never; @@ -8894,8 +9394,6 @@ export interface paths { * @description Gets your public key, which you need to encrypt secrets. You need to * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. - * * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/get-repo-public-key"]; @@ -11038,7 +11536,7 @@ export interface paths { * @description View the progress of an import. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -11082,7 +11580,7 @@ export interface paths { * return a status `422 Unprocessable Entity` response. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ put: operations["migrations/start-import"]; post?: never; @@ -11092,7 +11590,7 @@ export interface paths { * @description Stop an import for a repository. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ delete: operations["migrations/cancel-import"]; options?: never; @@ -11108,7 +11606,7 @@ export interface paths { * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/update-import"]; trace?: never; @@ -11128,7 +11626,7 @@ export interface paths { * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-commit-authors"]; put?: never; @@ -11159,7 +11657,7 @@ export interface paths { * new commits to the repository. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/map-commit-author"]; trace?: never; @@ -11177,7 +11675,7 @@ export interface paths { * @description List files larger than 100MB found during the import * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-large-files"]; put?: never; @@ -11211,7 +11709,7 @@ export interface paths { * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/set-lfs-preference"]; trace?: never; @@ -11540,7 +12038,7 @@ export interface paths { head?: never; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12638,7 +13136,7 @@ export interface paths { * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." @@ -12991,6 +13489,7 @@ export interface paths { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ put: operations["pulls/update-branch"]; post?: never; @@ -13885,10 +14384,10 @@ export interface paths { cookie?: never; }; /** - * Deprecated - List tag protection states for a repository + * Closing down - List tag protection states for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. * * This returns the tag protection states of a repository. * @@ -13897,10 +14396,10 @@ export interface paths { get: operations["repos/list-tag-protection"]; put?: never; /** - * Deprecated - Create a tag protection state for a repository + * Closing down - Create a tag protection state for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. * * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13923,10 +14422,10 @@ export interface paths { put?: never; post?: never; /** - * Deprecated - Delete a tag protection state for a repository + * Closing down - Delete a tag protection state for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. * * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -14428,7 +14927,7 @@ export interface paths { * Get a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; put?: never; @@ -14437,7 +14936,7 @@ export interface paths { * Delete a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -14450,7 +14949,7 @@ export interface paths { * Update a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * @@ -14471,7 +14970,7 @@ export interface paths { * List discussions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -14483,7 +14982,7 @@ export interface paths { * Create a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * @@ -14509,7 +15008,7 @@ export interface paths { * Get a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -14522,7 +15021,7 @@ export interface paths { * Delete a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -14535,7 +15034,7 @@ export interface paths { * Update a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -14555,7 +15054,7 @@ export interface paths { * List discussion comments (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -14567,7 +15066,7 @@ export interface paths { * Create a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * @@ -14593,7 +15092,7 @@ export interface paths { * Get a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -14606,7 +15105,7 @@ export interface paths { * Delete a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -14619,7 +15118,7 @@ export interface paths { * Update a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -14639,7 +15138,7 @@ export interface paths { * List reactions for a team discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14651,7 +15150,7 @@ export interface paths { * Create reaction for a team discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14677,7 +15176,7 @@ export interface paths { * List reactions for a team discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14689,7 +15188,7 @@ export interface paths { * Create reaction for a team discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14715,7 +15214,7 @@ export interface paths { * List pending team invitations (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ @@ -14739,7 +15238,7 @@ export interface paths { * List team members (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -14762,7 +15261,7 @@ export interface paths { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * @@ -14772,7 +15271,7 @@ export interface paths { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * @@ -14790,7 +15289,7 @@ export interface paths { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * @@ -14818,7 +15317,7 @@ export interface paths { * Get team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -14834,7 +15333,7 @@ export interface paths { * Add or update team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -14853,7 +15352,7 @@ export interface paths { * Remove team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -14879,7 +15378,7 @@ export interface paths { * List team projects (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -14903,7 +15402,7 @@ export interface paths { * Check team permissions for a project (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -14912,7 +15411,7 @@ export interface paths { * Add or update team project permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -14922,7 +15421,7 @@ export interface paths { * Remove a project from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -14943,7 +15442,7 @@ export interface paths { * List team repositories (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; put?: never; @@ -14965,7 +15464,7 @@ export interface paths { * Check team permissions for a repository (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * * > [!NOTE] * > Repositories inherited through a parent team will also be checked. @@ -14977,7 +15476,7 @@ export interface paths { * Add or update team repository permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -14989,7 +15488,7 @@ export interface paths { * Remove a repository from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -15010,7 +15509,7 @@ export interface paths { * List child teams (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; put?: never; @@ -16068,6 +16567,9 @@ export interface paths { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ get: operations["orgs/list-for-authenticated-user"]; put?: never; @@ -16089,7 +16591,7 @@ export interface paths { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; put?: never; @@ -16111,7 +16613,7 @@ export interface paths { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; put?: never; @@ -16120,7 +16622,7 @@ export interface paths { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; options?: never; @@ -16145,7 +16647,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; delete?: never; @@ -16165,7 +16667,7 @@ export interface paths { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; put?: never; @@ -16187,7 +16689,7 @@ export interface paths { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; put?: never; @@ -16198,7 +16700,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; options?: never; @@ -16223,7 +16725,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; delete?: never; @@ -16652,7 +17154,7 @@ export interface paths { }; /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). * * > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. @@ -16906,7 +17408,7 @@ export interface paths { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; put?: never; @@ -16928,7 +17430,7 @@ export interface paths { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; put?: never; @@ -16939,7 +17441,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; options?: never; @@ -16966,7 +17468,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; delete?: never; @@ -16986,7 +17488,7 @@ export interface paths { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; put?: never; @@ -17008,7 +17510,7 @@ export interface paths { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; put?: never; @@ -17019,7 +17521,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; options?: never; @@ -17046,7 +17548,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; delete?: never; @@ -17516,6 +18018,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; }; /** * @description The type of credit the user is receiving. @@ -17710,6 +18214,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; } | null; /** * GitHub app @@ -18227,7 +18733,7 @@ export interface components { */ organization_custom_properties: "read" | "write" | "admin"; /** - * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. * @enum {string} */ organization_copilot_seat_management: "write"; @@ -18262,7 +18768,7 @@ export interface components { */ organization_plan: "read"; /** - * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). + * @description The level of permission to grant the access token to manage organization projects and projects public preview (where available). * @enum {string} */ organization_projects: "read" | "write" | "admin"; @@ -18706,7 +19212,7 @@ export interface components { allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -19290,7 +19796,7 @@ export interface components { * Organization Simple * @description A GitHub organization. */ - "organization-simple": { + "nullable-organization-simple": { /** @example github */ login: string; /** @example 1 */ @@ -19324,7 +19830,7 @@ export interface components { avatar_url: string; /** @example A great organization */ description: string | null; - }; + } | null; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -19433,8 +19939,8 @@ export interface components { url: string; /** @example disabled | all */ sync_to_organizations: string; - /** @example 1 */ - group_id?: number | null; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id?: string | null; /** * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league @@ -19451,12 +19957,8 @@ export interface components { * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ "copilot-seat-details": { - /** @description The assignee that has been granted access to GitHub Copilot. */ - assignee: { - [key: string]: unknown; - } & components["schemas"]["simple-user"]; - /** @description The organization to which this seat belongs. */ - organization?: components["schemas"]["organization-simple"] | null; + assignee: components["schemas"]["simple-user"]; + organization?: components["schemas"]["nullable-organization-simple"]; /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; /** @@ -19481,6 +19983,157 @@ export interface components { * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. */ updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + "copilot-ide-code-completions": ({ + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + total_engaged_users: number; + /** @description Code completion metrics for active languages. */ + languages: { + /** @description Name of the language used for Copilot code completion suggestions. */ + name: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + total_engaged_users: number; + }[]; + editors: ({ + /** @description Name of the given editor. */ + name: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + total_engaged_users: number; + /** @description List of model metrics for custom models and the default model. */ + models: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + total_engaged_users: number; + /** @description Code completion metrics for active languages, for the given editor. */ + languages: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + total_engaged_users: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + total_code_suggestions: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + total_code_acceptances: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + total_code_lines_suggested: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + total_code_lines_accepted: number; + }[]; + }[]; + } & { + [key: string]: unknown; + })[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + "copilot-ide-chat": ({ + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + total_engaged_users: number; + editors: { + /** @description Name of the given editor. */ + name: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + total_engaged_users: number; + /** @description List of model metrics for custom models and the default model. */ + models: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + total_engaged_users: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + total_chats: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + total_chat_insertion_events: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + total_chat_copy_events: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in github.com */ + "copilot-dotcom-chat": ({ + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + total_engaged_users: number; + /** @description List of model metrics for a custom models and the default model. */ + models: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model: boolean; + /** @description The training date for the custom model (if applicable). */ + custom_model_training_date: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + total_engaged_users: number; + /** @description Total number of chats initiated by users on github.com. */ + total_chats: number; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot for pull requests. */ + "copilot-dotcom-pull-requests": ({ + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + total_engaged_users: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + repositories: { + /** @description Repository name */ + name: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + total_engaged_users: number; + /** @description List of model metrics for custom models and the default model. */ + models: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + total_pr_summaries_created: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + total_engaged_users: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_engaged_users?: number; + copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + } & { + [key: string]: unknown; }; /** * Copilot Usage Metrics @@ -19991,6 +20644,10 @@ export interface components { * @enum {string} */ validity: "active" | "inactive" | "unknown"; + /** @description Whether the secret was publicly leaked. */ + publicly_leaked: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + multi_repo: boolean | null; }; /** * Actor @@ -20438,6 +21095,11 @@ export interface components { language: string; raw_url: string; size: number; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding: string; }; }; public: boolean; @@ -20463,6 +21125,11 @@ export interface components { login: string; /** Format: int64 */ id: number; + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + user_view_type: "public"; node_id: string; /** Format: uri */ avatar_url: string; @@ -20512,8 +21179,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; /** @example 1 */ private_gists?: number; /** @example 2 */ @@ -20620,6 +21285,11 @@ export interface components { size: number; truncated: boolean; content: string; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding: string; } | null; }; public: boolean; @@ -20988,6 +21658,10 @@ export interface components { /** @enum {string} */ status: "enabled" | "disabled"; }; + secret_scanning_ai_detection: { + /** @enum {string} */ + status: "enabled" | "disabled"; + }; } | null; /** * Minimal Repository @@ -21254,6 +21928,45 @@ export interface components { */ repository_url?: string; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + avatar_url: string; + /** @example A great organization */ + description: string | null; + }; /** * Organization Full * @description Organization Full @@ -21339,7 +22052,12 @@ export interface components { private_gists?: number | null; /** @example 10000 */ disk_usage?: number | null; - /** @example 8 */ + /** + * @description The number of collaborators on private repositories. + * + * This field may be null if the number of private repositories is over 50,000. + * @example 8 + */ collaborators?: number | null; /** * Format: email @@ -21378,7 +22096,7 @@ export interface components { web_commit_signoff_required?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * @@ -21388,7 +22106,7 @@ export interface components { advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * @@ -21398,7 +22116,7 @@ export interface components { dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * @@ -21408,7 +22126,7 @@ export interface components { dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * @@ -21418,7 +22136,7 @@ export interface components { dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * @@ -21428,7 +22146,7 @@ export interface components { secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * @@ -21455,6 +22173,11 @@ export interface components { updated_at: string; /** Format: date-time */ archived_at: string | null; + /** + * @description Controls whether or not deploy keys may be added and used for repositories in the organization. + * @example false + */ + deploy_keys_enabled_for_repositories?: boolean; }; "actions-cache-usage-org-enterprise": { /** @description The count of active caches across all repositories of an enterprise or an organization. */ @@ -21541,6 +22264,31 @@ export interface components { default_workflow_permissions: components["schemas"]["actions-default-workflow-permissions"]; can_approve_pull_request_reviews: components["schemas"]["actions-can-approve-pull-request-reviews"]; }; + "runner-groups-org": { + id: number; + name: string; + visibility: string; + default: boolean; + /** @description Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ + selected_repositories_url?: string; + runners_url: string; + hosted_runners_url?: string; + inherited: boolean; + inherited_allows_public_repositories?: boolean; + allows_public_repositories: boolean; + /** + * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. + * @default false + */ + workflow_restrictions_read_only: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + restricted_to_workflows: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + selected_workflows?: string[]; + }; /** * Self hosted runner label * @description A label for a self hosted runner @@ -21741,9 +22489,9 @@ export interface components { "alert-instances-url": string; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} @@ -21850,7 +22598,7 @@ export interface components { * @description The type of the code security configuration. * @enum {string} */ - target_type: "global" | "organization"; + target_type: "global" | "organization" | "enterprise"; /** @description A description of the code security configuration */ description: string; /** @@ -21898,6 +22646,24 @@ export interface components { * @enum {string} */ secret_scanning_push_protection: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @enum {string} @@ -22225,8 +22991,8 @@ export interface components { inactive_this_cycle: number; }; /** - * Copilot Business Organization Details - * @description Information about the seat breakdown and policies set for an organization with a Copilot Business subscription. + * Copilot Organization Details + * @description Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription. */ "copilot-organization-details": { seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; @@ -22255,6 +23021,11 @@ export interface components { * @enum {string} */ seat_management_setting: "assign_all" | "assign_selected" | "disabled" | "unconfigured"; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; } & { [key: string]: unknown; }; @@ -22629,6 +23400,87 @@ export interface components { created_at: string; type: string; }; + /** + * Route Stats + * @description API Insights usage route stats for an actor + */ + "api-insights-route-stats": { + /** @description The HTTP method */ + http_method: string; + /** @description The API path's route template */ + api_route: string; + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count: number; + last_rate_limited_timestamp: string | null; + last_request_timestamp: string; + }[]; + /** + * Subject Stats + * @description API Insights usage subject stats for an organization + */ + "api-insights-subject-stats": { + subject_type: string; + subject_name: string; + /** Format: int64 */ + subject_id: number; + total_request_count: number; + rate_limited_request_count: number; + last_rate_limited_timestamp: string | null; + last_request_timestamp: string; + }[]; + /** + * Summary Stats + * @description API Insights usage summary stats for an organization + */ + "api-insights-summary-stats": { + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count: number; + }; + /** + * Time Stats + * @description API Insights usage time stats for an organization + */ + "api-insights-time-stats": { + timestamp: string; + /** Format: int64 */ + total_request_count: number; + /** Format: int64 */ + rate_limited_request_count: number; + }[]; + /** + * User Stats + * @description API Insights usage stats for a user + */ + "api-insights-user-stats": { + actor_type: string; + actor_name: string; + /** Format: int64 */ + actor_id: number; + /** Format: int64 */ + integration_id: number | null; + /** Format: int64 */ + oauth_application_id: number | null; + total_request_count: number; + rate_limited_request_count: number; + last_rate_limited_timestamp: string | null; + last_request_timestamp: string; + }[]; /** * @description The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. * @example collaborators_only @@ -22933,6 +23785,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; }; /** * Package Version @@ -23021,6 +23875,10 @@ export interface components { }; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -23033,7 +23891,7 @@ export interface components { * @description Minimal representation of an organization programmatic access grant for enumerations */ "organization-programmatic-access-grant": { - /** @description Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token. */ + /** @description Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. */ id: number; owner: components["schemas"]["simple-user"]; /** @@ -23057,6 +23915,10 @@ export interface components { }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ access_granted_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -23485,7 +24347,7 @@ export interface components { allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -23893,7 +24755,8 @@ export interface components { */ actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. + * @default always * @enum {string} */ bypass_mode: "always" | "pull_request"; @@ -23963,7 +24826,9 @@ export interface components { }; /** * Organization ruleset conditions - * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. + * @description Conditions for an organization ruleset. + * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + * The push rulesets conditions object does not require the `ref_name` property. */ "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24052,6 +24917,18 @@ export interface components { /** @enum {string} */ type: "required_signatures"; }; + /** + * RequiredReviewerConfiguration + * @description A reviewing team, and file patterns describing which files they must approve changes to. + */ + "repository-rule-params-required-reviewer-configuration": { + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files. */ + file_patterns: string[]; + /** @description Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. */ + minimum_approvals: number; + /** @description Node ID of the team which must review changes to matching files. */ + reviewer_id: string; + }; /** * pull_request * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -24351,7 +25228,7 @@ export interface components { html: { /** @description The html URL of the ruleset */ href: string; - }; + } | null; }; conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; rules?: components["schemas"]["repository-rule"][]; @@ -26462,6 +27339,7 @@ export interface components { received_events_url: string; type: string; site_admin: boolean; + user_view_type: string; }[]; teams: { id: number; @@ -26517,6 +27395,8 @@ export interface components { type: string; /** @example false */ site_admin: boolean; + /** @example public */ + user_view_type: string; }; name: string; client_id: string; @@ -27067,7 +27947,10 @@ export interface components { * @description A suite of checks performed on the code of a given code change */ "check-suite": { - /** @example 5 */ + /** + * Format: int64 + * @example 5 + */ id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ node_id: string; @@ -27687,6 +28570,8 @@ export interface components { }; /** @example admin */ role_name: string; + /** @example public */ + user_view_type?: string; }; /** * Repository Invitation @@ -27802,6 +28687,8 @@ export interface components { }; /** @example admin */ role_name: string; + /** @example public */ + user_view_type?: string; } | null; /** * Repository Collaborator Permission @@ -28175,6 +29062,7 @@ export interface components { name: string; path: string; sha: string; + content?: string; /** Format: uri */ url: string; /** Format: uri */ @@ -28188,7 +29076,6 @@ export interface components { size: number; name: string; path: string; - content?: string; sha: string; /** Format: uri */ url: string; @@ -28250,7 +29137,10 @@ export interface components { * @description Content File */ "content-file": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ type: "file"; encoding: string; size: number; @@ -28284,7 +29174,10 @@ export interface components { * @description An object describing a symlink */ "content-symlink": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ type: "symlink"; target: string; size: number; @@ -28313,7 +29206,10 @@ export interface components { * @description An object describing a submodule */ "content-submodule": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ type: "submodule"; /** Format: uri */ submodule_git_url: string; @@ -28442,6 +29338,7 @@ export interface components { contributions: number; email?: string; name?: string; + user_view_type?: string; }; /** @description A Dependabot alert. */ "dependabot-alert": { @@ -28548,6 +29445,11 @@ export interface components { * @example SPDX-2.3 */ spdxVersion: string; + /** + * @description An optional comment about the SPDX document. + * @example Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/ + */ + comment?: string; creationInfo: { /** * @description The date and time the SPDX document was created. @@ -28567,11 +29469,9 @@ export interface components { * @example CC0-1.0 */ dataLicense: string; - /** @description The name of the repository that the SPDX document describes. */ - documentDescribes: string[]; /** * @description The namespace for the SPDX document. - * @example https://github.com/example/dependency_graph/sbom-123 + * @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 */ documentNamespace: string; packages: { @@ -28582,7 +29482,7 @@ export interface components { SPDXID: string; /** * @description The name of the package. - * @example rubygems:github/github + * @example github/github */ name: string; /** @@ -28642,6 +29542,17 @@ export interface components { referenceType: string; }[]; }[]; + relationships?: { + /** + * @description The type of relationship between the two SPDX elements. + * @example DEPENDS_ON + */ + relationshipType: string; + /** @description The SPDX identifier of the package that is the source of the relationship. */ + spdxElementId: string; + /** @description The SPDX identifier of the package that is the target of the relationship. */ + relatedSpdxElement: string; + }[]; }; }; /** @@ -28797,7 +29708,7 @@ export interface components { environment: string; /** * Format: uri - * @description Deprecated: the URL to associate with this status. + * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ @@ -30159,12 +31070,12 @@ export interface components { */ path: string; /** - * @description The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. + * @description The line index in the diff to which the comment applies. This field is closing down; use `line` instead. * @example 1 */ position?: number; /** - * @description The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. + * @description The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. * @example 4 */ original_position?: number; @@ -30364,6 +31275,7 @@ export interface components { read_only: boolean; added_by?: string | null; last_used?: string | null; + enabled?: boolean; }; /** * Language @@ -30824,361 +31736,16 @@ export interface components { head: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: { - key: string; - name: string; - /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; - } | null; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; - web_commit_signoff_required?: boolean; - } | null; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - /** Format: int64 */ - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; base: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: components["schemas"]["nullable-license-simple"]; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - web_commit_signoff_required?: boolean; - }; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - /** Format: int64 */ - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; _links: { comments: components["schemas"]["link"]; @@ -31552,6 +32119,10 @@ export interface components { * @enum {string} */ validity: "active" | "inactive" | "unknown"; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked: boolean | null; + /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + multi_repo: boolean | null; }; /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ "secret-scanning-alert-resolution-comment": string | null; @@ -32446,6 +33017,7 @@ export interface components { company?: string | null; /** Format: date-time */ suspended_at?: string | null; + user_view_type?: string; }; /** * Private User @@ -32459,6 +33031,11 @@ export interface components { * @example 1 */ id: number; + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + user_view_type: "private"; /** @example MDQ6VXNlcjE= */ node_id: string; /** @@ -32573,8 +33150,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; business_plus?: boolean; ldap_dn?: string; }; @@ -33614,7 +34189,7 @@ export interface components { allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -33675,75 +34250,6 @@ export interface components { /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; }; - /** - * Simple User - * @description The GitHub user that triggered the event. This property is included in every webhook payload. - */ - "simple-user-webhooks": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** @example 1 */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; - /** - * Format: uri - * @example https://api.github.com/users/octocat - */ - url: string; - /** - * Format: uri - * @example https://github.com/octocat - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/followers - */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions - */ - subscriptions_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs - */ - organizations_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/repos - */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events - */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - }; /** * branch protection rule * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. @@ -33916,6 +34422,7 @@ export interface components { /** Format: uri */ url: string; verified: boolean; + enabled?: boolean; }; /** Workflow */ webhooks_workflow: { @@ -33954,6 +34461,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type: string; }; webhooks_reviewers: { /** User */ @@ -34043,6 +34551,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; webhooks_answer: { /** @@ -34114,6 +34623,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -34159,6 +34669,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; answer_html_url: string | null; /** @@ -34258,6 +34769,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; labels?: components["schemas"]["label"][]; }; @@ -34329,6 +34841,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Label */ @@ -34458,6 +34971,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The changes to the comment. */ @@ -34510,6 +35024,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -34546,6 +35061,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -34633,6 +35149,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -34715,6 +35232,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -34876,6 +35394,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -34924,6 +35443,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -34992,6 +35512,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -35028,6 +35549,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -35115,6 +35637,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -35197,6 +35720,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -35358,6 +35882,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** User */ @@ -35396,6 +35921,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Marketplace Purchase */ webhooks_marketplace_purchase: { @@ -35975,7 +36501,7 @@ export interface components { allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -36082,6 +36608,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36155,6 +36682,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -36221,6 +36749,10 @@ export interface components { }[] | null; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -36276,6 +36808,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -36332,6 +36865,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ html_url: string; @@ -36551,7 +37085,7 @@ export interface components { */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ use_squash_pr_title_as_default: boolean; @@ -36639,6 +37173,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36727,6 +37262,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -36950,6 +37486,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -37059,6 +37596,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -37294,6 +37832,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -37403,6 +37942,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -37470,6 +38010,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -37517,6 +38058,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -37740,6 +38282,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -37886,6 +38429,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The review that was affected. */ @@ -37959,6 +38503,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; webhooks_nullable_string: string | null; @@ -38065,6 +38610,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -38212,6 +38758,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -38361,6 +38908,10 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at: string | null; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + multi_repo: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { @@ -38421,6 +38972,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type: string; }; node_id: string; privacy_level: string; @@ -38460,6 +39012,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** User */ sponsorable: { @@ -38497,6 +39050,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Sponsorship Tier @@ -38608,7 +39162,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection configuration enabled event */ "webhook-branch-protection-configuration-enabled": { @@ -38618,7 +39172,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule created event */ "webhook-branch-protection-rule-created": { @@ -38629,7 +39183,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ "webhook-branch-protection-rule-deleted": { @@ -38640,7 +39194,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ "webhook-branch-protection-rule-edited": { @@ -38691,7 +39245,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ "webhook-check-run-completed": { @@ -38701,7 +39255,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event @@ -38719,7 +39273,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event @@ -38742,7 +39296,7 @@ export interface components { /** @description The integrator reference of the action requested by the user. */ identifier: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event @@ -38760,7 +39314,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event @@ -38834,6 +39388,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39011,7 +39566,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite requested event */ "webhook-check-suite-requested": { @@ -39077,6 +39632,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39254,7 +39810,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite rerequested event */ "webhook-check-suite-rerequested": { @@ -39320,6 +39876,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39497,7 +40054,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert appeared_in_branch event */ "webhook-code-scanning-alert-appeared-in-branch": { @@ -39551,6 +40108,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -39623,7 +40181,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ "webhook-code-scanning-alert-closed-by-user": { @@ -39677,6 +40235,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -39756,7 +40315,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ "webhook-code-scanning-alert-created": { @@ -39831,9 +40390,9 @@ export interface components { }; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - state: "open" | "dismissed"; + state: "open" | "dismissed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -39851,7 +40410,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ "webhook-code-scanning-alert-fixed": { @@ -39905,6 +40464,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -39986,7 +40546,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ "webhook-code-scanning-alert-reopened": { @@ -40079,7 +40639,7 @@ export interface components { /** @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. */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ "webhook-code-scanning-alert-reopened-by-user": { @@ -40163,7 +40723,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** commit_comment created event */ "webhook-commit-comment-created": { @@ -40172,7 +40732,7 @@ export interface components { * @enum {string} */ action: "created"; - /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ + /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ comment: { /** * AuthorAssociation @@ -40251,13 +40811,14 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** create event */ "webhook-create": { @@ -40276,7 +40837,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** custom property created event */ "webhook-custom-property-created": { @@ -40286,7 +40847,7 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property deleted event */ "webhook-custom-property-deleted": { @@ -40299,7 +40860,7 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property updated event */ "webhook-custom-property-updated": { @@ -40309,7 +40870,7 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Custom property values updated event */ "webhook-custom-property-values-updated": { @@ -40319,7 +40880,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; repository: components["schemas"]["repository-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description The new custom property values for the repository. */ new_property_values: components["schemas"]["custom-property-value"][]; /** @description The old custom property values for the repository. */ @@ -40338,7 +40899,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-dismissed event */ "webhook-dependabot-alert-auto-dismissed": { @@ -40349,7 +40910,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-reopened event */ "webhook-dependabot-alert-auto-reopened": { @@ -40360,7 +40921,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ "webhook-dependabot-alert-created": { @@ -40371,7 +40932,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ "webhook-dependabot-alert-dismissed": { @@ -40382,7 +40943,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ "webhook-dependabot-alert-fixed": { @@ -40393,7 +40954,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ "webhook-dependabot-alert-reintroduced": { @@ -40404,7 +40965,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ "webhook-dependabot-alert-reopened": { @@ -40415,7 +40976,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ "webhook-deploy-key-created": { @@ -40426,7 +40987,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ "webhook-deploy-key-deleted": { @@ -40437,7 +40998,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deployment created event */ "webhook-deployment-created": { @@ -40485,6 +41046,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -40547,6 +41109,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40643,7 +41206,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run: { @@ -40683,6 +41246,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -40917,6 +41481,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -40944,7 +41509,7 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; installation: components["schemas"]["simple-installation"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-deployment-review-approved": { /** @enum {string} */ @@ -40956,7 +41521,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -41007,6 +41572,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -41075,6 +41641,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type: string; }; private: boolean; pulls_url: string; @@ -41185,6 +41752,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type: string; }; private: boolean; pulls_url: string; @@ -41241,6 +41809,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -41260,7 +41829,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -41311,6 +41880,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -41378,6 +41948,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type: string; }; private: boolean; pulls_url: string; @@ -41488,6 +42059,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type: string; }; private: boolean; pulls_url: string; @@ -41544,6 +42116,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -41600,11 +42173,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @enum {string} */ type: "User" | "Team"; }[]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { conclusion: unknown; @@ -41654,6 +42228,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -41721,6 +42296,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type: string; }; private: boolean; pulls_url: string; @@ -41831,6 +42407,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type: string; }; private: boolean; pulls_url: string; @@ -41887,6 +42464,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -41973,6 +42551,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -42035,6 +42614,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42166,6 +42746,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ deployment_url: string; @@ -42233,6 +42814,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42326,7 +42908,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run?: { @@ -42366,6 +42948,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -42600,6 +43183,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -42619,7 +43203,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion category changed event */ "webhook-discussion-category-changed": { @@ -42647,7 +43231,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion closed event */ "webhook-discussion-closed": { @@ -42658,7 +43242,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment created event */ "webhook-discussion-comment-created": { @@ -42670,7 +43254,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment deleted event */ "webhook-discussion-comment-deleted": { @@ -42682,7 +43266,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment edited event */ "webhook-discussion-comment-edited": { @@ -42699,7 +43283,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion created event */ "webhook-discussion-created": { @@ -42710,7 +43294,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion deleted event */ "webhook-discussion-deleted": { @@ -42721,7 +43305,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion edited event */ "webhook-discussion-edited": { @@ -42740,7 +43324,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion labeled event */ "webhook-discussion-labeled": { @@ -42752,7 +43336,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ "webhook-discussion-locked": { @@ -42763,7 +43347,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion pinned event */ "webhook-discussion-pinned": { @@ -42774,7 +43358,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion reopened event */ "webhook-discussion-reopened": { @@ -42785,7 +43369,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion transferred event */ "webhook-discussion-transferred": { @@ -42800,7 +43384,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unanswered event */ "webhook-discussion-unanswered": { @@ -42810,7 +43394,7 @@ export interface components { old_answer: components["schemas"]["webhooks_answer"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ "webhook-discussion-unlabeled": { @@ -42822,7 +43406,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ "webhook-discussion-unlocked": { @@ -42833,7 +43417,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unpinned event */ "webhook-discussion-unpinned": { @@ -42844,7 +43428,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * fork event @@ -43040,6 +43624,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -43191,13 +43776,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ "webhook-github-app-authorization-revoked": { /** @enum {string} */ action: "revoked"; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** gollum event */ "webhook-gollum": { @@ -43225,7 +43810,7 @@ export interface components { title: string; }[]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation created event */ "webhook-installation-created": { @@ -43237,7 +43822,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ "webhook-installation-deleted": { @@ -43249,7 +43834,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ "webhook-installation-new-permissions-accepted": { @@ -43261,7 +43846,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ "webhook-installation-repositories-added": { @@ -43285,7 +43870,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ "webhook-installation-repositories-removed": { @@ -43309,7 +43894,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ "webhook-installation-suspend": { @@ -43321,7 +43906,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { @@ -43361,6 +43946,7 @@ export interface components { updated_at?: string; url?: string; website_url?: unknown; + user_view_type?: string; }; /** @enum {string} */ action: "renamed"; @@ -43376,7 +43962,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; target_type: string; }; /** installation unsuspend event */ @@ -43389,7 +43975,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ "webhook-issue-comment-created": { @@ -43479,6 +44065,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -43523,6 +44110,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -43559,6 +44147,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -43646,6 +44235,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -43728,6 +44318,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -43889,6 +44480,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -43928,6 +44520,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: Record[]; author_association?: string; @@ -44006,7 +44599,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ "webhook-issue-comment-deleted": { @@ -44055,6 +44648,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -44091,6 +44685,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -44178,6 +44773,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -44260,6 +44856,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -44421,6 +45018,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -44460,6 +45058,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: Record[]; author_association?: string; @@ -44534,11 +45133,12 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment edited event */ "webhook-issue-comment-edited": { @@ -44588,6 +45188,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -44624,6 +45225,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -44711,6 +45313,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -44793,6 +45396,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -44954,6 +45558,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -44993,6 +45598,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: Record[]; author_association?: string; @@ -45071,7 +45677,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues assigned event */ "webhook-issues-assigned": { @@ -45086,7 +45692,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues closed event */ "webhook-issues-closed": { @@ -45137,6 +45743,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -45173,6 +45780,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -45260,6 +45868,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -45342,6 +45951,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -45503,6 +46113,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -45563,11 +46174,12 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues deleted event */ "webhook-issues-deleted": { @@ -45618,6 +46230,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -45741,6 +46354,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -45823,6 +46437,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -45984,11 +46599,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues demilestoned event */ "webhook-issues-demilestoned": { @@ -46162,6 +46778,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -46244,6 +46861,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -46405,12 +47023,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues edited event */ "webhook-issues-edited": { @@ -46472,6 +47091,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46595,6 +47215,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -46677,6 +47298,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -46838,12 +47460,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues labeled event */ "webhook-issues-labeled": { @@ -46894,6 +47517,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47017,6 +47641,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -47099,6 +47724,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -47260,12 +47886,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues locked event */ "webhook-issues-locked": { @@ -47316,6 +47943,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47352,6 +47980,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47440,6 +48069,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -47522,6 +48152,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -47683,11 +48314,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ "webhook-issues-milestoned": { @@ -47861,6 +48493,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -47943,6 +48576,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -48104,12 +48738,13 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues opened event */ "webhook-issues-opened": { @@ -48159,6 +48794,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48195,6 +48831,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48282,6 +48919,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -48364,6 +49002,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -48525,6 +49164,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } | null; /** @@ -48724,6 +49364,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -48819,6 +49460,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48855,6 +49497,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48942,6 +49585,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49024,6 +49668,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -49185,11 +49830,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ "webhook-issues-pinned": { @@ -49200,7 +49846,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ "webhook-issues-reopened": { @@ -49374,6 +50020,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49456,6 +50103,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -49617,11 +50265,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ "webhook-issues-transferred": { @@ -49671,6 +50320,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -49707,6 +50357,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -49794,6 +50445,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49876,6 +50528,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -50037,6 +50690,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -50239,6 +50893,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50294,7 +50949,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ "webhook-issues-unassigned": { @@ -50309,7 +50964,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ "webhook-issues-unlabeled": { @@ -50321,7 +50976,7 @@ export interface components { label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ "webhook-issues-unlocked": { @@ -50372,6 +51027,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -50408,6 +51064,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -50496,6 +51153,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -50578,6 +51236,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -50739,11 +51398,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ "webhook-issues-unpinned": { @@ -50754,7 +51414,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label created event */ "webhook-label-created": { @@ -50765,7 +51425,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ "webhook-label-deleted": { @@ -50776,7 +51436,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label edited event */ "webhook-label-edited": { @@ -50802,7 +51462,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase cancelled event */ "webhook-marketplace-purchase-cancelled": { @@ -50815,7 +51475,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase changed event */ "webhook-marketplace-purchase-changed": { @@ -50854,7 +51514,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change event */ "webhook-marketplace-purchase-pending-change": { @@ -50893,7 +51553,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change_cancelled event */ "webhook-marketplace-purchase-pending-change-cancelled": { @@ -50932,7 +51592,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase purchased event */ "webhook-marketplace-purchase-purchased": { @@ -50945,7 +51605,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member added event */ "webhook-member-added": { @@ -50970,7 +51630,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member edited event */ "webhook-member-edited": { @@ -50992,7 +51652,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member removed event */ "webhook-member-removed": { @@ -51003,7 +51663,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** membership added event */ "webhook-membership-added": { @@ -51055,6 +51715,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -51108,6 +51769,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -51118,7 +51780,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-merge-group-destroyed": { /** @enum {string} */ @@ -51132,7 +51794,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** meta deleted event */ "webhook-meta-deleted": { @@ -51162,7 +51824,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ "webhook-milestone-closed": { @@ -51173,7 +51835,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone created event */ "webhook-milestone-created": { @@ -51184,7 +51846,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ "webhook-milestone-deleted": { @@ -51195,7 +51857,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ "webhook-milestone-edited": { @@ -51221,7 +51883,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ "webhook-milestone-opened": { @@ -51232,7 +51894,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block blocked event */ "webhook-org-block-blocked": { @@ -51243,7 +51905,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block unblocked event */ "webhook-org-block-unblocked": { @@ -51254,7 +51916,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization deleted event */ "webhook-organization-deleted": { @@ -51265,7 +51927,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ "webhook-organization-member-added": { @@ -51276,7 +51938,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ "webhook-organization-member-invited": { @@ -51331,6 +51993,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; login: string | null; node_id: string; @@ -51340,7 +52003,7 @@ export interface components { }; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ @@ -51352,7 +52015,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ "webhook-organization-renamed": { @@ -51368,7 +52031,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ "webhook-rubygems-metadata": { @@ -51442,6 +52105,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -51481,6 +52145,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body?: string | Record; body_html?: string; @@ -51609,6 +52274,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -51644,7 +52310,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** package updated event */ "webhook-package-updated": { @@ -51699,6 +52365,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -51738,6 +52405,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string; body_html: string; @@ -51809,6 +52477,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -51845,7 +52514,7 @@ export interface components { updated_at: string; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** page_build event */ "webhook-page-build": { @@ -51893,6 +52562,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; status: string; updated_at: string; @@ -51904,7 +52574,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** personal_access_token_request approved event */ "webhook-personal-access-token-request-approved": { @@ -51913,7 +52583,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request cancelled event */ @@ -51923,7 +52593,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request created event */ @@ -51933,7 +52603,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation?: components["schemas"]["simple-installation"]; }; /** personal_access_token_request denied event */ @@ -51943,7 +52613,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; organization: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; "webhook-ping": { @@ -51990,7 +52660,7 @@ export interface components { hook_id: number; organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ zen: string; }; @@ -52013,7 +52683,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card created event */ "webhook-project-card-created": { @@ -52024,7 +52694,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ "webhook-project-card-deleted": { @@ -52081,6 +52751,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -52094,7 +52765,7 @@ export interface components { url: string; }; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ "webhook-project-card-edited": { @@ -52110,7 +52781,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ "webhook-project-card-moved": { @@ -52171,6 +52842,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -52216,7 +52888,7 @@ export interface components { url?: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project closed event */ "webhook-project-closed": { @@ -52227,7 +52899,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_column created event */ "webhook-project-column-created": { @@ -52238,7 +52910,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ "webhook-project-column-deleted": { @@ -52249,7 +52921,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ "webhook-project-column-edited": { @@ -52265,7 +52937,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ "webhook-project-column-moved": { @@ -52276,7 +52948,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project created event */ "webhook-project-created": { @@ -52287,7 +52959,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project deleted event */ "webhook-project-deleted": { @@ -52298,7 +52970,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project edited event */ "webhook-project-edited": { @@ -52320,7 +52992,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ "webhook-project-reopened": { @@ -52331,7 +53003,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ "webhook-projects-v2-project-closed": { @@ -52340,7 +53012,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ "webhook-projects-v2-project-created": { @@ -52349,7 +53021,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ "webhook-projects-v2-project-deleted": { @@ -52358,7 +53030,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ "webhook-projects-v2-project-edited": { @@ -52385,7 +53057,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ "webhook-projects-v2-item-archived": { @@ -52395,7 +53067,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ "webhook-projects-v2-item-converted": { @@ -52410,7 +53082,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ "webhook-projects-v2-item-created": { @@ -52419,7 +53091,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ "webhook-projects-v2-item-deleted": { @@ -52428,7 +53100,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ "webhook-projects-v2-item-edited": { @@ -52454,7 +53126,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ "webhook-projects-v2-item-reordered": { @@ -52469,7 +53141,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ "webhook-projects-v2-item-restored": { @@ -52479,7 +53151,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ "webhook-projects-v2-project-reopened": { @@ -52488,7 +53160,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Created Event */ "webhook-projects-v2-status-update-created": { @@ -52497,7 +53169,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Deleted Event */ "webhook-projects-v2-status-update-deleted": { @@ -52506,7 +53178,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Edited Event */ "webhook-projects-v2-status-update-edited": { @@ -52539,7 +53211,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** public event */ "webhook-public": { @@ -52547,7 +53219,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request assigned event */ "webhook-pull-request-assigned": { @@ -52641,6 +53313,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -52677,6 +53350,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -52729,6 +53403,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -52952,6 +53627,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53012,7 +53688,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -53061,6 +53737,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -53296,6 +53973,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53356,7 +54034,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -53405,6 +54083,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -53472,6 +54151,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -53519,6 +54199,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -53585,6 +54266,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -53742,10 +54424,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ "webhook-pull-request-auto-merge-disabled": { @@ -53838,6 +54521,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -53926,6 +54610,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -54149,6 +54834,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54209,7 +54895,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -54258,6 +54944,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -54493,6 +55180,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54553,7 +55241,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -54602,6 +55290,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -54669,6 +55358,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -54716,6 +55406,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -54782,6 +55473,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -54939,11 +55631,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ "webhook-pull-request-auto-merge-enabled": { @@ -55036,6 +55729,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -55124,6 +55818,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -55347,6 +56042,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55407,7 +56103,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -55456,6 +56152,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -55688,6 +56385,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55748,7 +56446,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -55797,6 +56495,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -55864,6 +56563,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -55911,6 +56611,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -55977,6 +56678,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -56134,11 +56836,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason?: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ "webhook-pull-request-closed": { @@ -56150,7 +56853,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ "webhook-pull-request-converted-to-draft": { @@ -56162,7 +56865,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ "webhook-pull-request-demilestoned": { @@ -56174,7 +56877,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request dequeued event */ "webhook-pull-request-dequeued": { @@ -56267,6 +56970,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -56355,6 +57059,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -56578,6 +57283,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56638,7 +57344,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -56687,6 +57393,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -56922,6 +57629,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56982,7 +57690,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -57031,6 +57739,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -57098,6 +57807,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -57145,6 +57855,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -57211,6 +57922,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -57368,11 +58080,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - reason: string; + /** @enum {string} */ + reason: "UNKNOWN_REMOVAL_REASON" | "MANUAL" | "MERGE" | "MERGE_CONFLICT" | "CI_FAILURE" | "CI_TIMEOUT" | "ALREADY_MERGED" | "QUEUE_CLEARED" | "ROLL_BACK" | "BRANCH_PROTECTIONS" | "GIT_TREE_INVALID" | "INVALID_MERGE_COMMIT"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request edited event */ "webhook-pull-request-edited": { @@ -57403,7 +58117,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request enqueued event */ "webhook-pull-request-enqueued": { @@ -57496,6 +58210,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -57584,6 +58299,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -57807,6 +58523,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57867,7 +58584,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -57916,6 +58633,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -58151,6 +58869,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58211,7 +58930,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -58260,6 +58979,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -58327,6 +59047,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -58374,6 +59095,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -58440,6 +59162,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -58597,10 +59320,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ "webhook-pull-request-labeled": { @@ -58694,6 +59418,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -58782,6 +59507,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -59005,6 +59731,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59065,7 +59792,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -59114,6 +59841,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -59349,6 +60077,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59409,7 +60138,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -59458,6 +60187,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -59525,6 +60255,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -59572,6 +60303,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -59638,6 +60370,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -59795,10 +60528,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ "webhook-pull-request-locked": { @@ -59891,6 +60625,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -59979,6 +60714,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -60202,6 +60938,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60262,7 +60999,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -60311,6 +61048,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -60546,6 +61284,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60606,7 +61345,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -60655,6 +61394,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -60722,6 +61462,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -60769,6 +61510,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -60835,6 +61577,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -60992,10 +61735,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ "webhook-pull-request-milestoned": { @@ -61007,7 +61751,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ "webhook-pull-request-opened": { @@ -61019,7 +61763,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ "webhook-pull-request-ready-for-review": { @@ -61031,7 +61775,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ "webhook-pull-request-reopened": { @@ -61043,7 +61787,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ "webhook-pull-request-review-comment-created": { @@ -61193,6 +61937,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -61279,6 +62024,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -61367,6 +62113,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -61590,6 +62337,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61650,7 +62398,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -61699,6 +62447,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -61927,6 +62676,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61987,7 +62737,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -62036,6 +62786,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -62107,6 +62858,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -62171,6 +62923,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -62322,10 +63075,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ "webhook-pull-request-review-comment-deleted": { @@ -62416,6 +63170,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -62504,6 +63259,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -62727,6 +63483,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62787,7 +63544,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -62836,6 +63593,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -63064,6 +63822,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63124,7 +63883,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -63173,6 +63932,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -63244,6 +64004,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -63308,6 +64069,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -63459,10 +64221,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ "webhook-pull-request-review-comment-edited": { @@ -63554,6 +64317,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -63590,6 +64354,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -63642,6 +64407,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -63865,6 +64631,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63925,7 +64692,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -63974,6 +64741,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -64202,6 +64970,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64262,7 +65031,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -64311,6 +65080,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -64382,6 +65152,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -64446,6 +65217,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -64595,12 +65367,13 @@ export interface components { subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; + user_view_type?: string; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ "webhook-pull-request-review-dismissed": { @@ -64691,6 +65464,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -64779,6 +65553,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -65002,6 +65777,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65062,7 +65838,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -65111,6 +65887,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -65339,6 +66116,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65399,7 +66177,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -65448,6 +66226,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -65519,6 +66298,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -65583,6 +66363,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -65734,6 +66515,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -65809,9 +66591,10 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ "webhook-pull-request-review-edited": { @@ -65908,6 +66691,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -65996,6 +66780,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -66197,6 +66982,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66282,6 +67068,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -66488,6 +67275,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66573,6 +67361,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -66644,6 +67433,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -66708,6 +67498,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -66859,11 +67650,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ "webhook-pull-request-review-request-removed": { @@ -66957,6 +67749,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -66993,6 +67786,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -67045,6 +67839,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -67268,6 +68063,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67321,7 +68117,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -67370,6 +68166,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -67605,6 +68402,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67665,7 +68463,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -67714,6 +68512,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -67781,6 +68580,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -67828,6 +68628,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -67894,6 +68695,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -68051,6 +68853,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -68090,8 +68893,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ action: "review_request_removed"; @@ -68183,6 +68987,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -68219,6 +69024,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -68271,6 +69077,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -68494,6 +69301,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68554,7 +69362,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -68603,6 +69411,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -68838,6 +69647,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68898,7 +69708,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -68947,6 +69757,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -69014,6 +69825,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -69061,6 +69873,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -69127,6 +69940,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -69284,6 +70098,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -69342,7 +70157,7 @@ export interface components { */ url: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_requested event */ "webhook-pull-request-review-requested": { @@ -69436,6 +70251,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -69472,6 +70288,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -69524,6 +70341,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -69747,6 +70565,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69807,7 +70626,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -69856,6 +70675,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -70091,6 +70911,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -70151,7 +70972,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -70200,6 +71021,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -70267,6 +71089,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -70314,6 +71137,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -70380,6 +71204,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -70537,6 +71362,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -70576,8 +71402,9 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ action: "review_requested"; @@ -70669,6 +71496,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -70705,6 +71533,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -70757,6 +71586,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -70980,6 +71810,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71040,7 +71871,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -71089,6 +71920,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -71324,6 +72156,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71384,7 +72217,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -71433,6 +72266,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -71500,6 +72334,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -71547,6 +72382,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -71613,6 +72449,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -71770,6 +72607,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -71828,7 +72666,7 @@ export interface components { */ url?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review submitted event */ "webhook-pull-request-review-submitted": { @@ -71919,6 +72757,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -72007,6 +72846,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -72230,6 +73070,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72290,7 +73131,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -72339,6 +73180,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -72567,6 +73409,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72627,7 +73470,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -72676,6 +73519,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -72747,6 +73591,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -72811,6 +73656,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -72962,11 +73808,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ "webhook-pull-request-review-thread-resolved": { @@ -73057,6 +73904,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -73145,6 +73993,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -73351,6 +74200,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73438,6 +74288,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -73649,6 +74500,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73736,6 +74588,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -73807,6 +74660,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -73871,6 +74725,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -74022,10 +74877,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -74167,6 +75023,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -74261,6 +75118,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -74349,6 +75207,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -74555,6 +75414,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -74642,6 +75502,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -74853,6 +75714,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -74940,6 +75802,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -75011,6 +75874,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -75075,6 +75939,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -75226,10 +76091,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -75371,6 +76237,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -75469,6 +76336,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -75557,6 +76425,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -75780,6 +76649,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -75840,7 +76710,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -75889,6 +76759,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -76117,6 +76988,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -76177,7 +77049,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -76226,6 +77098,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -76293,6 +77166,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -76340,6 +77214,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -76406,6 +77281,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -76563,10 +77439,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ "webhook-pull-request-unassigned": { @@ -76660,6 +77537,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -76748,6 +77626,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -76971,6 +77850,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -77031,7 +77911,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -77080,6 +77960,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -77315,6 +78196,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -77375,7 +78257,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -77424,6 +78306,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -77491,6 +78374,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -77538,6 +78422,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -77604,6 +78489,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -77761,10 +78647,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ "webhook-pull-request-unlabeled": { @@ -77858,6 +78745,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -77946,6 +78834,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -78169,6 +79058,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -78229,7 +79119,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -78278,6 +79168,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -78506,6 +79397,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -78566,7 +79458,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -78615,6 +79507,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -78682,6 +79575,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -78729,6 +79623,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -78795,6 +79690,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -78952,10 +79848,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ "webhook-pull-request-unlocked": { @@ -79048,6 +79945,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -79136,6 +80034,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -79359,6 +80258,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -79419,7 +80319,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -79468,6 +80368,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -79703,6 +80604,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -79763,7 +80665,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -79812,6 +80714,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -79879,6 +80782,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -79926,6 +80830,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -79992,6 +80897,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -80149,10 +81055,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** push event */ "webhook-push": { @@ -80489,6 +81396,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -80538,7 +81446,7 @@ export interface components { /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-registry-package-published": { /** @enum {string} */ @@ -80573,6 +81481,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -80595,6 +81504,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body?: string | Record; body_html?: string; @@ -80704,6 +81614,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type: string; }; created_at: string; draft: boolean; @@ -80734,7 +81645,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-registry-package-updated": { /** @enum {string} */ @@ -80769,6 +81680,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -80791,6 +81703,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body: string; body_html: string; @@ -80843,6 +81756,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; created_at: string; draft: boolean; @@ -80867,7 +81781,7 @@ export interface components { updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release created event */ "webhook-release-created": { @@ -80878,7 +81792,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release deleted event */ "webhook-release-deleted": { @@ -80889,7 +81803,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release edited event */ "webhook-release-edited": { @@ -80914,7 +81828,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ "webhook-release-prereleased": { @@ -81026,6 +81940,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -81074,7 +81989,7 @@ export interface components { zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release published event */ "webhook-release-published": { @@ -81085,7 +82000,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release released event */ "webhook-release-released": { @@ -81096,7 +82011,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ "webhook-release-unpublished": { @@ -81107,7 +82022,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory published event */ "webhook-repository-advisory-published": { @@ -81118,7 +82033,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory reported event */ "webhook-repository-advisory-reported": { @@ -81129,7 +82044,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ "webhook-repository-archived": { @@ -81139,7 +82054,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository created event */ "webhook-repository-created": { @@ -81149,7 +82064,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository deleted event */ "webhook-repository-deleted": { @@ -81159,7 +82074,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { @@ -81174,7 +82089,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository edited event */ "webhook-repository-edited": { @@ -81198,7 +82113,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_import event */ "webhook-repository-import": { @@ -81206,7 +82121,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @enum {string} */ status: "success" | "cancelled" | "failure"; }; @@ -81218,7 +82133,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository publicized event */ "webhook-repository-publicized": { @@ -81228,7 +82143,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository renamed event */ "webhook-repository-renamed": { @@ -81245,7 +82160,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset created event */ "webhook-repository-ruleset-created": { @@ -81256,7 +82171,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset deleted event */ "webhook-repository-ruleset-deleted": { @@ -81267,7 +82182,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset edited event */ "webhook-repository-ruleset-edited": { @@ -81325,7 +82240,7 @@ export interface components { }[]; }; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ "webhook-repository-transferred": { @@ -81396,6 +82311,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; }; @@ -81404,7 +82320,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository unarchived event */ "webhook-repository-unarchived": { @@ -81414,7 +82330,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert create event */ "webhook-repository-vulnerability-alert-create": { @@ -81425,7 +82341,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert dismiss event */ "webhook-repository-vulnerability-alert-dismiss": { @@ -81478,6 +82394,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; external_identifier: string; /** Format: uri */ @@ -81498,7 +82415,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert reopen event */ "webhook-repository-vulnerability-alert-reopen": { @@ -81509,7 +82426,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert resolve event */ "webhook-repository-vulnerability-alert-resolve": { @@ -81581,7 +82498,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** secret_scanning_alert created event */ "webhook-secret-scanning-alert-created": { @@ -81592,7 +82509,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created": { @@ -81603,13 +82520,24 @@ export interface components { location: components["schemas"]["secret-scanning-location"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created-form-encoded": { /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ payload: string; }; + /** secret_scanning_alert publicly leaked event */ + "webhook-secret-scanning-alert-publicly-leaked": { + /** @enum {string} */ + action: "publicly_leaked"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** secret_scanning_alert reopened event */ "webhook-secret-scanning-alert-reopened": { /** @enum {string} */ @@ -81619,7 +82547,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert resolved event */ "webhook-secret-scanning-alert-resolved": { @@ -81630,7 +82558,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert validated event */ "webhook-secret-scanning-alert-validated": { @@ -81641,7 +82569,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ "webhook-security-advisory-published": { @@ -81652,7 +82580,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ "webhook-security-advisory-updated": { @@ -81663,7 +82591,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ "webhook-security-advisory-withdrawn": { @@ -81711,7 +82639,7 @@ export interface components { }[]; withdrawn_at: string; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ "webhook-security-and-analysis": { @@ -81724,7 +82652,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["full-repository"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ "webhook-sponsorship-cancelled": { @@ -81734,7 +82662,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ @@ -81745,7 +82673,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ @@ -81762,7 +82690,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ @@ -81774,7 +82702,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ @@ -81787,7 +82715,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ @@ -81799,7 +82727,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ @@ -81810,7 +82738,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: string | null; }; @@ -81822,7 +82750,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: unknown; }; @@ -81986,7 +82914,7 @@ export interface components { name: string; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ sha: string; /** @@ -82012,7 +82940,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** parent issue removed event */ "webhook-sub-issues-parent-issue-removed": { @@ -82028,7 +82956,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sub-issue added event */ "webhook-sub-issues-sub-issue-added": { @@ -82044,7 +82972,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sub-issue removed event */ "webhook-sub-issues-sub-issue-removed": { @@ -82060,7 +82988,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** team_add event */ "webhook-team-add": { @@ -82068,7 +82996,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ @@ -82273,6 +83201,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -82320,7 +83249,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ @@ -82525,6 +83454,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -82572,7 +83502,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ @@ -82777,6 +83707,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -82824,7 +83755,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ @@ -83060,6 +83991,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -83107,7 +84039,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ @@ -83312,6 +84244,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -83359,7 +84292,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ @@ -83370,7 +84303,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** workflow_dispatch event */ "webhook-workflow-dispatch": { @@ -83382,7 +84315,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: string; }; /** workflow_job completed event */ @@ -83393,7 +84326,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -83483,7 +84416,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -83581,7 +84514,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -83635,7 +84568,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -83689,7 +84622,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -83729,6 +84662,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -83879,6 +84813,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -84051,6 +84986,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -84119,6 +85055,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -84142,7 +85079,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -84590,7 +85527,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -84630,6 +85567,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -84780,6 +85718,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -84952,6 +85891,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -85020,6 +85960,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -85113,6 +86054,15 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + usage_metrics_api_disabled: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Service unavailable */ service_unavailable: { headers: { @@ -85361,6 +86311,12 @@ export interface components { "secret-scanning-alert-sort": "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ "secret-scanning-alert-validity": string; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + "secret-scanning-alert-publicly-leaked": boolean; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + "secret-scanning-alert-multi-repo": boolean; + /** @description The slug of the enterprise team name. */ + "enterprise-team-slug": string; /** @description The slug of the team name. */ "team-slug": string; /** @description The unique identifier of the gist. */ @@ -85393,6 +86349,10 @@ export interface components { org: string; /** @description The unique identifier of the repository. */ "repository-id": number; + /** @description Only return runner groups that are allowed to be used by this repository. */ + "visible-to-repository": string; + /** @description Unique identifier of the self-hosted runner group. */ + "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ "runner-id": number; /** @description The name of a self-hosted runner's custom label. */ @@ -85413,6 +86373,22 @@ export interface components { "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; + /** @description The type of the actor */ + "api-insights-actor-type": "installations" | "classic_pats" | "fine_grained_pats" | "oauth_apps" | "github_apps_user_to_server"; + /** @description The ID of the actor */ + "api-insights-actor-id": number; + /** @description The minimum timestamp to query for stats */ + "api-insights-min-timestamp": string; + /** @description The maximum timestamp to query for stats */ + "api-insights-max-timestamp": string; + /** @description The property to sort the results by. */ + "api-insights-route-stats-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[]; + /** @description The property to sort the results by. */ + "api-insights-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[]; + /** @description The ID of the user to query for stats */ + "api-insights-user-id": string; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + "api-insights-timestamp-increment": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The name of the codespace. */ @@ -85448,8 +86424,13 @@ export interface components { "personal-access-token-after": string; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ "custom-property-name": string; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + "ruleset-targets": string; /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ @@ -85542,6 +86523,8 @@ export interface components { status: "queued" | "in_progress" | "completed"; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ "git-ref": components["schemas"]["code-scanning-ref"]; + /** @description The number of the pull request for the results you want to list. */ + "pr-alias": number; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -85865,7 +86848,6 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; header?: never; path?: never; @@ -86340,7 +87322,7 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "classroom/list-accepted-assigments-for-an-assignment": { + "classroom/list-accepted-assignments-for-an-assignment": { parameters: { query?: { /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -86574,6 +87556,42 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "copilot/copilot-metrics-for-enterprise": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-enterprise": { parameters: { query?: { @@ -86697,6 +87715,10 @@ export interface operations { after?: components["parameters"]["pagination-after"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; header?: never; path: { @@ -86721,6 +87743,44 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "copilot/copilot-metrics-for-enterprise-team": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the enterprise team name. */ + team_slug: components["parameters"]["enterprise-team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-enterprise-team": { parameters: { query?: { @@ -88302,7 +89362,7 @@ export interface operations { members_can_create_public_repositories: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type: "all" | "private" | "none"; @@ -88335,7 +89395,7 @@ export interface operations { blog: string; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88346,7 +89406,7 @@ export interface operations { advanced_security_enabled_for_new_repositories: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * @@ -88357,7 +89417,7 @@ export interface operations { dependabot_alerts_enabled_for_new_repositories: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * @@ -88368,7 +89428,7 @@ export interface operations { dependabot_security_updates_enabled_for_new_repositories: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88379,7 +89439,7 @@ export interface operations { dependency_graph_enabled_for_new_repositories: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88390,7 +89450,7 @@ export interface operations { secret_scanning_enabled_for_new_repositories: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88403,6 +89463,8 @@ export interface operations { secret_scanning_push_protection_custom_link_enabled: boolean; /** @description If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. */ secret_scanning_push_protection_custom_link: string; + /** @description Controls whether or not deploy keys may be added and used for repositories in the organization. */ + deploy_keys_enabled_for_repositories: boolean; }; }; }; @@ -88788,6 +89850,415 @@ export interface operations { }; }; }; + "actions/list-self-hosted-runner-groups-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description Only return runner groups that are allowed to be used by this repository. */ + visible_to_repository?: components["parameters"]["visible-to-repository"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runner_groups: components["schemas"]["runner-groups-org"][]; + }; + }; + }; + }; + }; + "actions/create-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner group. */ + name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. + * @default all + * @enum {string} + */ + visibility?: "selected" | "all" | "private"; + /** @description List of repository IDs that can access the runner group. */ + selected_repository_ids?: number[]; + /** @description List of runner IDs to add to the runner group. */ + runners?: number[]; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + allows_public_repositories?: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + restricted_to_workflows?: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + selected_workflows?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + "actions/get-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + "actions/delete-self-hosted-runner-group-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/update-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner group. */ + name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. + * @enum {string} + */ + visibility?: "selected" | "all" | "private"; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + allows_public_repositories?: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + restricted_to_workflows?: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + selected_workflows?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + "actions/list-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + }; + "actions/set-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of repository IDs that can access the runner group. */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/add-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/list-self-hosted-runners-in-group-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; + }; + }; + }; + }; + }; + "actions/set-self-hosted-runners-in-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of runner IDs to add to the runner group. */ + runners: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/add-self-hosted-runner-to-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/remove-self-hosted-runner-from-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "actions/list-self-hosted-runners-for-org": { parameters: { query?: { @@ -89962,6 +91433,25 @@ export interface operations { * @enum {string} */ secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @default disabled @@ -90166,6 +91656,24 @@ export interface operations { * @enum {string} */ secret_scanning_push_protection: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @enum {string} @@ -90227,7 +91735,7 @@ export interface operations { * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` * @enum {string} */ - scope: "all" | "public" | "private_or_internal" | "selected"; + scope: "all" | "all_without_configurations" | "public" | "private_or_internal" | "selected"; /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ selected_repository_ids?: number[]; }; @@ -91013,6 +92521,42 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "copilot/copilot-metrics-for-organization": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-org": { parameters: { query?: { @@ -91610,45 +93154,286 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "orgs/update-webhook": { + "orgs/update-webhook": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Key/value pairs to provide settings for this webhook. */ + config: { + url: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + /** + * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. + * @default [ + * "push" + * ] + */ + events: string[]; + /** + * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + * @default true + */ + active: boolean; + /** @example "web" */ + name: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-hook"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/get-webhook-config-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + }; + "orgs/update-webhook-config-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + url: components["schemas"]["webhook-config-url"]; + content_type: components["schemas"]["webhook-config-content-type"]; + secret: components["schemas"]["webhook-config-secret"]; + insecure_ssl: components["schemas"]["webhook-config-insecure-ssl"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + }; + "orgs/list-webhook-deliveries": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ + cursor?: components["parameters"]["cursor"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["hook-delivery-item"][]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/get-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["hook-delivery"]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/redeliver-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/ping-webhook": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "api-insights/get-route-stats-by-actor": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: components["parameters"]["api-insights-route-stats-sort"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; + /** @description The type of the actor */ + actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + actor_id: components["parameters"]["api-insights-actor-id"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** @description Key/value pairs to provide settings for this webhook. */ - config: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - /** - * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. - * @default [ - * "push" - * ] - */ - events: string[]; - /** - * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - * @default true - */ - active: boolean; - /** @example "web" */ - name: string; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["api-insights-route-stats"]; }; }; }; + }; + "api-insights/get-subject-stats": { + parameters: { + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: components["parameters"]["api-insights-sort"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -91656,22 +93441,23 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-hook"]; + "application/json": components["schemas"]["api-insights-subject-stats"]; }; }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/get-webhook-config-for-org": { + "api-insights/get-summary-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; }; cookie?: never; }; @@ -91683,33 +93469,61 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - "orgs/update-webhook-config-for-org": { + "api-insights/get-summary-stats-by-user": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; + /** @description The ID of the user to query for stats */ + user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - url: components["schemas"]["webhook-config-url"]; - content_type: components["schemas"]["webhook-config-content-type"]; - secret: components["schemas"]["webhook-config-secret"]; - insecure_ssl: components["schemas"]["webhook-config-insecure-ssl"]; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; + }; + "api-insights/get-summary-stats-by-actor": { + parameters: { + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The type of the actor */ + actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + actor_id: components["parameters"]["api-insights-actor-id"]; + }; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -91717,26 +93531,25 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - "orgs/list-webhook-deliveries": { + "api-insights/get-time-stats": { parameters: { - query?: { - /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: components["parameters"]["per-page"]; - /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; }; cookie?: never; }; @@ -91748,23 +93561,27 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["hook-delivery-item"][]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/get-webhook-delivery": { + "api-insights/get-time-stats-by-user": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; + /** @description The ID of the user to query for stats */ + user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; @@ -91776,55 +93593,81 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["hook-delivery"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/redeliver-webhook-delivery": { + "api-insights/get-time-stats-by-actor": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; + /** @description The type of the actor */ + actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + actor_id: components["parameters"]["api-insights-actor-id"]; }; cookie?: never; }; requestBody?: never; responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; }; }; - "orgs/ping-webhook": { + "api-insights/get-user-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: components["parameters"]["api-insights-sort"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; + /** @description The ID of the user to query for stats */ + user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["api-insights-user-stats"]; + }; }; - 404: components["responses"]["not_found"]; }; }; "apps/get-org-installation": { @@ -93805,7 +95648,7 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; @@ -93832,7 +95675,7 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; @@ -93879,7 +95722,7 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; @@ -94191,7 +96034,7 @@ export interface operations { delete_branch_on_merge?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -94263,6 +96106,11 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + targets?: components["parameters"]["ruleset-targets"]; }; header?: never; path: { @@ -94526,6 +96374,10 @@ export interface operations { after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; header?: never; path: { @@ -94726,6 +96578,44 @@ export interface operations { }; }; }; + "copilot/copilot-metrics-for-team": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-team": { parameters: { query?: { @@ -94836,7 +96726,7 @@ export interface operations { */ notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -94946,7 +96836,7 @@ export interface operations { */ notification_setting: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -96957,6 +98847,11 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status: string; }; + /** @description Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." */ + secret_scanning_ai_detection: { + /** @description Can be `enabled` or `disabled`. */ + status: string; + }; /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_scanning_non_provider_patterns: { /** @description Can be `enabled` or `disabled`. */ @@ -97017,7 +98912,7 @@ export interface operations { allow_update_branch: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -99799,7 +101694,7 @@ export interface operations { strict: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -100268,7 +102163,7 @@ export interface operations { strict: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -100527,12 +102422,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ apps: string[]; - } | string[]; + }; }; }; responses: { @@ -100562,12 +102457,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ apps: string[]; - } | string[]; + }; }; }; responses: { @@ -100597,12 +102492,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ apps: string[]; - } | string[]; + }; }; }; responses: { @@ -100793,12 +102688,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ users: string[]; - } | string[]; + }; }; }; responses: { @@ -100828,12 +102723,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ users: string[]; - } | string[]; + }; }; }; responses: { @@ -100863,12 +102758,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ users: string[]; - } | string[]; + }; }; }; responses: { @@ -101458,8 +103353,14 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["git-ref"]; + /** @description The number of the pull request for the results you want to list. */ + pr?: components["parameters"]["pr-alias"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; /** @description The property by which to sort the results. */ sort?: "created" | "updated"; /** @description If specified, only code scanning alerts with this state will be returned. */ @@ -101571,6 +103472,8 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["git-ref"]; + /** @description The number of the pull request for the results you want to list. */ + pr?: components["parameters"]["pr-alias"]; }; header?: never; path: { @@ -101610,6 +103513,8 @@ export interface operations { page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The number of the pull request for the results you want to list. */ + pr?: components["parameters"]["pr-alias"]; /** @description The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ @@ -101770,6 +103675,34 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "code-scanning/delete-codeql-database": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The language of the CodeQL database. */ + language: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "code-scanning/create-variant-analysis": { parameters: { query?: never; @@ -102176,7 +104109,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -103069,7 +105002,7 @@ export interface operations { path?: string; /** @description Line index in the diff to comment on. */ position?: number; - /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ + /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ line?: number; }; }; @@ -103614,7 +105547,7 @@ export interface operations { direction?: components["parameters"]["direction"]; /** * @deprecated - * @description **Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. + * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. */ page?: number; /** @@ -104325,7 +106258,7 @@ export interface operations { "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ event_type: string; - /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ + /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. */ client_payload?: { [key: string]: unknown; }; @@ -106050,7 +107983,6 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; header?: never; path: { @@ -106740,7 +108672,7 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ + /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ assignee?: string | null; milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ @@ -107125,7 +109057,7 @@ export interface operations { title: (string | number) | null; /** @description The contents of the issue. */ body: string | null; - /** @description Username to assign to this issue. **This field is deprecated.** */ + /** @description Username to assign to this issue. **This field is closing down.** */ assignee: string | null; /** * @description The open or closed state of the issue. @@ -109569,7 +111501,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -109681,7 +111613,7 @@ export interface operations { path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * @description **This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ position?: number; /** @@ -111096,6 +113028,11 @@ export interface operations { page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + targets?: components["parameters"]["ruleset-targets"]; }; header?: never; path: { @@ -111374,6 +113311,10 @@ export interface operations { after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; header?: never; path: { @@ -112736,12 +114677,12 @@ export interface operations { q: string; /** * @deprecated - * @description **This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) + * @description **This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "indexed"; /** * @deprecated - * @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + * @description **This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -113080,7 +115021,7 @@ export interface operations { */ notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -114372,7 +116313,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -114403,7 +116344,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -115232,6 +117173,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; "users/unfollow": { diff --git a/packages/openapi-typescript/examples/github-api-root-types.ts b/packages/openapi-typescript/examples/github-api-root-types.ts index 6b7911c8b..c2a9cdbee 100644 --- a/packages/openapi-typescript/examples/github-api-root-types.ts +++ b/packages/openapi-typescript/examples/github-api-root-types.ts @@ -453,7 +453,7 @@ export interface paths { * List accepted assignments for an assignment * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ - get: operations["classroom/list-accepted-assigments-for-an-assignment"]; + get: operations["classroom/list-accepted-assignments-for-an-assignment"]; put?: never; post?: never; delete?: never; @@ -612,13 +612,16 @@ export interface paths { /** * List all Copilot seat assignments for an enterprise * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + * Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. * * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. * * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + * telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + * see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. * @@ -633,6 +636,35 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for an enterprise + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/enterprises/{enterprise}/copilot/usage": { parameters: { query?: never; @@ -643,7 +675,7 @@ export interface paths { /** * Get a summary of Copilot usage for enterprise members * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -653,6 +685,8 @@ export interface paths { * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * + * The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + * * Only owners and billing managers can view Copilot usage metrics for the enterprise. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -718,6 +752,38 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for an enterprise team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-enterprise-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { parameters: { query?: never; @@ -728,7 +794,7 @@ export interface paths { /** * Get a summary of Copilot usage for an enterprise team * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -1609,10 +1675,10 @@ export interface paths { /** * Update an organization * @description > [!WARNING] - * > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * > **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * > [!WARNING] - * > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * * Updates the organization's profile and member privileges. * @@ -1842,6 +1908,180 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List self-hosted runner groups for an organization + * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-self-hosted-runner-groups-for-org"]; + put?: never; + /** + * Create a self-hosted runner group for an organization + * @description Creates a new self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["actions/create-self-hosted-runner-group-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a self-hosted runner group for an organization + * @description Gets a specific self-hosted runner group for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/get-self-hosted-runner-group-for-org"]; + put?: never; + post?: never; + /** + * Delete a self-hosted runner group from an organization + * @description Deletes a self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + options?: never; + head?: never; + /** + * Update a self-hosted runner group for an organization + * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + patch: operations["actions/update-self-hosted-runner-group-for-org"]; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List repository access to a self-hosted runner group in an organization + * @description Lists the repositories with access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; + /** + * Set repository access for a self-hosted runner group in an organization + * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Add repository access to a self-hosted runner group in an organization + * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; + /** + * Remove repository access to a self-hosted runner group in an organization + * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List self-hosted runners in a group for an organization + * @description Lists self-hosted runners that are in a specific organization group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-self-hosted-runners-in-group-for-org"]; + /** + * Set self-hosted runners in a group for an organization + * @description Replaces the list of self-hosted runners that are part of an organization runner group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Add a self-hosted runner to a group for an organization + * @description Adds a self-hosted runner to a runner group configured in an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + post?: never; + /** + * Remove a self-hosted runner from a group for an organization + * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/runners": { parameters: { query?: never; @@ -2912,11 +3152,11 @@ export interface paths { /** * Get Copilot seat information and settings for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Gets information about an organization's Copilot subscription, including seat breakdown * and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." * * Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. * @@ -2941,11 +3181,14 @@ export interface paths { /** * List all Copilot seat assignments for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + * Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. * Only organization owners can view assigned seats. * + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/list-copilot-seats"]; @@ -2969,16 +3212,16 @@ export interface paths { /** * Add teams to the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * * Only organization owners can add Copilot seats for their organization members. * * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * * The response will contain the total number of new seats that were created and existing seats that were refreshed. * @@ -2988,17 +3231,19 @@ export interface paths { /** * Remove teams from the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Cancels the Copilot seat assignment for all members of each team specified. - * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Sets seats for all members of each team specified to "pending cancellation". + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * + * The response will contain the total number of seats set to "pending cancellation". + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; @@ -3019,16 +3264,16 @@ export interface paths { /** * Add users to the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * * Only organization owners can add Copilot seats for their organization members. * * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * * The response will contain the total number of new seats that were created and existing seats that were refreshed. * @@ -3038,17 +3283,19 @@ export interface paths { /** * Remove users from the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Cancels the Copilot seat assignment for each user specified. - * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Sets seats for all users specified to "pending cancellation". + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * + * The response will contain the total number of seats set to "pending cancellation". + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; @@ -3057,6 +3304,38 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for an organization + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + * Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/copilot/usage": { parameters: { query?: never; @@ -3067,7 +3346,7 @@ export interface paths { /** * Get a summary of Copilot usage for organization members * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -3534,6 +3813,186 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get route stats by actor + * @description Get API request count statistics for an actor broken down by route within a specified time frame. + */ + get: operations["api-insights/get-route-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/subject-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get subject stats + * @description Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + */ + get: operations["api-insights/get-subject-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/summary-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get summary stats + * @description Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + */ + get: operations["api-insights/get-summary-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get summary stats by user + * @description Get overall statistics of API requests within the organization for a user. + */ + get: operations["api-insights/get-summary-stats-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get summary stats by actor + * @description Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + */ + get: operations["api-insights/get-summary-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/time-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get time stats + * @description Get the number of API requests and rate-limited requests made within an organization over a specified time period. + */ + get: operations["api-insights/get-time-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/time-stats/users/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get time stats by user + * @description Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + */ + get: operations["api-insights/get-time-stats-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get time stats by actor + * @description Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + */ + get: operations["api-insights/get-time-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/user-stats/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get user stats + * @description Get API usage statistics within an organization for a user broken down by the type of access. + */ + get: operations["api-insights/get-user-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/installation": { parameters: { query?: never; @@ -3831,9 +4290,12 @@ export interface paths { /** * Get Copilot seat assignment details for a user * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + * + * The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * * Only organization owners can view Copilot seat assignment details for members of their organization. * @@ -4272,7 +4734,7 @@ export interface paths { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; put?: never; @@ -4294,7 +4756,7 @@ export interface paths { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; put?: never; @@ -4305,7 +4767,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; options?: never; @@ -4332,7 +4794,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; delete?: never; @@ -4352,7 +4814,7 @@ export interface paths { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; put?: never; @@ -4374,7 +4836,7 @@ export interface paths { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; put?: never; @@ -4385,7 +4847,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; options?: never; @@ -4412,7 +4874,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; delete?: never; @@ -5041,6 +5503,38 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for a team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + * Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/team/{team_slug}/copilot/usage": { parameters: { query?: never; @@ -5051,7 +5545,7 @@ export interface paths { /** * Get a summary of Copilot usage for a team * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -5689,7 +6183,7 @@ export interface paths { * Enable or disable a security feature for an organization * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). * * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -5949,7 +6443,7 @@ export interface paths { * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." * * > [!NOTE] - * > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; put?: never; @@ -8355,7 +8849,7 @@ export interface paths { * and `0` is returned in this field. * * > [!WARNING] - * > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -8482,7 +8976,7 @@ export interface paths { * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-codeql-databases"]; put?: never; @@ -8510,12 +9004,18 @@ export interface paths { * your HTTP client is configured to follow redirects or use the `Location` header * to make a second request to get the redirect URL. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-codeql-database"]; put?: never; post?: never; - delete?: never; + /** + * Delete a CodeQL database + * @description Deletes a CodeQL database for a language in a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + delete: operations["code-scanning/delete-codeql-database"]; options?: never; head?: never; patch?: never; @@ -8894,8 +9394,6 @@ export interface paths { * @description Gets your public key, which you need to encrypt secrets. You need to * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. - * * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/get-repo-public-key"]; @@ -11038,7 +11536,7 @@ export interface paths { * @description View the progress of an import. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -11082,7 +11580,7 @@ export interface paths { * return a status `422 Unprocessable Entity` response. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ put: operations["migrations/start-import"]; post?: never; @@ -11092,7 +11590,7 @@ export interface paths { * @description Stop an import for a repository. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ delete: operations["migrations/cancel-import"]; options?: never; @@ -11108,7 +11606,7 @@ export interface paths { * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/update-import"]; trace?: never; @@ -11128,7 +11626,7 @@ export interface paths { * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-commit-authors"]; put?: never; @@ -11159,7 +11657,7 @@ export interface paths { * new commits to the repository. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/map-commit-author"]; trace?: never; @@ -11177,7 +11675,7 @@ export interface paths { * @description List files larger than 100MB found during the import * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-large-files"]; put?: never; @@ -11211,7 +11709,7 @@ export interface paths { * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/set-lfs-preference"]; trace?: never; @@ -11540,7 +12038,7 @@ export interface paths { head?: never; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12638,7 +13136,7 @@ export interface paths { * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." @@ -12991,6 +13489,7 @@ export interface paths { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ put: operations["pulls/update-branch"]; post?: never; @@ -13885,10 +14384,10 @@ export interface paths { cookie?: never; }; /** - * Deprecated - List tag protection states for a repository + * Closing down - List tag protection states for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. * * This returns the tag protection states of a repository. * @@ -13897,10 +14396,10 @@ export interface paths { get: operations["repos/list-tag-protection"]; put?: never; /** - * Deprecated - Create a tag protection state for a repository + * Closing down - Create a tag protection state for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. * * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13923,10 +14422,10 @@ export interface paths { put?: never; post?: never; /** - * Deprecated - Delete a tag protection state for a repository + * Closing down - Delete a tag protection state for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. * * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -14428,7 +14927,7 @@ export interface paths { * Get a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; put?: never; @@ -14437,7 +14936,7 @@ export interface paths { * Delete a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -14450,7 +14949,7 @@ export interface paths { * Update a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * @@ -14471,7 +14970,7 @@ export interface paths { * List discussions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -14483,7 +14982,7 @@ export interface paths { * Create a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * @@ -14509,7 +15008,7 @@ export interface paths { * Get a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -14522,7 +15021,7 @@ export interface paths { * Delete a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -14535,7 +15034,7 @@ export interface paths { * Update a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -14555,7 +15054,7 @@ export interface paths { * List discussion comments (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -14567,7 +15066,7 @@ export interface paths { * Create a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * @@ -14593,7 +15092,7 @@ export interface paths { * Get a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -14606,7 +15105,7 @@ export interface paths { * Delete a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -14619,7 +15118,7 @@ export interface paths { * Update a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -14639,7 +15138,7 @@ export interface paths { * List reactions for a team discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14651,7 +15150,7 @@ export interface paths { * Create reaction for a team discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14677,7 +15176,7 @@ export interface paths { * List reactions for a team discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14689,7 +15188,7 @@ export interface paths { * Create reaction for a team discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14715,7 +15214,7 @@ export interface paths { * List pending team invitations (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ @@ -14739,7 +15238,7 @@ export interface paths { * List team members (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -14762,7 +15261,7 @@ export interface paths { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * @@ -14772,7 +15271,7 @@ export interface paths { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * @@ -14790,7 +15289,7 @@ export interface paths { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * @@ -14818,7 +15317,7 @@ export interface paths { * Get team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -14834,7 +15333,7 @@ export interface paths { * Add or update team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -14853,7 +15352,7 @@ export interface paths { * Remove team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -14879,7 +15378,7 @@ export interface paths { * List team projects (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -14903,7 +15402,7 @@ export interface paths { * Check team permissions for a project (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -14912,7 +15411,7 @@ export interface paths { * Add or update team project permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -14922,7 +15421,7 @@ export interface paths { * Remove a project from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -14943,7 +15442,7 @@ export interface paths { * List team repositories (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; put?: never; @@ -14965,7 +15464,7 @@ export interface paths { * Check team permissions for a repository (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * * > [!NOTE] * > Repositories inherited through a parent team will also be checked. @@ -14977,7 +15476,7 @@ export interface paths { * Add or update team repository permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -14989,7 +15488,7 @@ export interface paths { * Remove a repository from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -15010,7 +15509,7 @@ export interface paths { * List child teams (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; put?: never; @@ -16068,6 +16567,9 @@ export interface paths { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ get: operations["orgs/list-for-authenticated-user"]; put?: never; @@ -16089,7 +16591,7 @@ export interface paths { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; put?: never; @@ -16111,7 +16613,7 @@ export interface paths { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; put?: never; @@ -16120,7 +16622,7 @@ export interface paths { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; options?: never; @@ -16145,7 +16647,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; delete?: never; @@ -16165,7 +16667,7 @@ export interface paths { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; put?: never; @@ -16187,7 +16689,7 @@ export interface paths { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; put?: never; @@ -16198,7 +16700,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; options?: never; @@ -16223,7 +16725,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; delete?: never; @@ -16652,7 +17154,7 @@ export interface paths { }; /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). * * > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. @@ -16906,7 +17408,7 @@ export interface paths { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; put?: never; @@ -16928,7 +17430,7 @@ export interface paths { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; put?: never; @@ -16939,7 +17441,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; options?: never; @@ -16966,7 +17468,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; delete?: never; @@ -16986,7 +17488,7 @@ export interface paths { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; put?: never; @@ -17008,7 +17510,7 @@ export interface paths { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; put?: never; @@ -17019,7 +17521,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; options?: never; @@ -17046,7 +17548,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; delete?: never; @@ -17516,6 +18018,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; }; /** * @description The type of credit the user is receiving. @@ -17710,6 +18214,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; } | null; /** * GitHub app @@ -18227,7 +18733,7 @@ export interface components { */ organization_custom_properties?: "read" | "write" | "admin"; /** - * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. * @enum {string} */ organization_copilot_seat_management?: "write"; @@ -18262,7 +18768,7 @@ export interface components { */ organization_plan?: "read"; /** - * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). + * @description The level of permission to grant the access token to manage organization projects and projects public preview (where available). * @enum {string} */ organization_projects?: "read" | "write" | "admin"; @@ -18706,7 +19212,7 @@ export interface components { allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -19290,7 +19796,7 @@ export interface components { * Organization Simple * @description A GitHub organization. */ - "organization-simple": { + "nullable-organization-simple": { /** @example github */ login: string; /** @example 1 */ @@ -19324,7 +19830,7 @@ export interface components { avatar_url: string; /** @example A great organization */ description: string | null; - }; + } | null; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -19433,8 +19939,8 @@ export interface components { url: string; /** @example disabled | all */ sync_to_organizations: string; - /** @example 1 */ - group_id?: number | null; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id?: string | null; /** * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league @@ -19451,12 +19957,8 @@ export interface components { * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ "copilot-seat-details": { - /** @description The assignee that has been granted access to GitHub Copilot. */ - assignee: { - [key: string]: unknown; - } & components["schemas"]["simple-user"]; - /** @description The organization to which this seat belongs. */ - organization?: components["schemas"]["organization-simple"] | null; + assignee: components["schemas"]["simple-user"]; + organization?: components["schemas"]["nullable-organization-simple"]; /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; /** @@ -19481,6 +19983,157 @@ export interface components { * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. */ updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + "copilot-ide-code-completions": ({ + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + }[]; + editors?: ({ + /** @description Name of the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages, for the given editor. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + total_code_suggestions?: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + total_code_acceptances?: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + total_code_lines_suggested?: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + total_code_lines_accepted?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + })[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + "copilot-ide-chat": ({ + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + total_engaged_users?: number; + editors?: { + /** @description Name of the given editor. */ + name?: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + total_engaged_users?: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + total_chats?: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + total_chat_insertion_events?: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + total_chat_copy_events?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in github.com */ + "copilot-dotcom-chat": ({ + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + total_engaged_users?: number; + /** @description List of model metrics for a custom models and the default model. */ + models?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model (if applicable). */ + custom_model_training_date?: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + total_engaged_users?: number; + /** @description Total number of chats initiated by users on github.com. */ + total_chats?: number; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot for pull requests. */ + "copilot-dotcom-pull-requests": ({ + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + total_engaged_users?: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + repositories?: { + /** @description Repository name */ + name?: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + total_pr_summaries_created?: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + total_engaged_users?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_engaged_users?: number; + copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + } & { + [key: string]: unknown; }; /** * Copilot Usage Metrics @@ -19991,6 +20644,10 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; + /** @description Whether the secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + multi_repo?: boolean | null; }; /** * Actor @@ -20438,6 +21095,11 @@ export interface components { language?: string; raw_url?: string; size?: number; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding: string; }; }; public: boolean; @@ -20463,6 +21125,11 @@ export interface components { login: string; /** Format: int64 */ id: number; + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + user_view_type: "public"; node_id: string; /** Format: uri */ avatar_url: string; @@ -20512,8 +21179,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; /** @example 1 */ private_gists?: number; /** @example 2 */ @@ -20620,6 +21285,11 @@ export interface components { size?: number; truncated?: boolean; content?: string; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding: string; } | null; }; public?: boolean; @@ -20988,6 +21658,10 @@ export interface components { /** @enum {string} */ status?: "enabled" | "disabled"; }; + secret_scanning_ai_detection?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; } | null; /** * Minimal Repository @@ -21254,6 +21928,45 @@ export interface components { */ repository_url?: string; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + avatar_url: string; + /** @example A great organization */ + description: string | null; + }; /** * Organization Full * @description Organization Full @@ -21339,7 +22052,12 @@ export interface components { private_gists?: number | null; /** @example 10000 */ disk_usage?: number | null; - /** @example 8 */ + /** + * @description The number of collaborators on private repositories. + * + * This field may be null if the number of private repositories is over 50,000. + * @example 8 + */ collaborators?: number | null; /** * Format: email @@ -21378,7 +22096,7 @@ export interface components { web_commit_signoff_required?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * @@ -21388,7 +22106,7 @@ export interface components { advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * @@ -21398,7 +22116,7 @@ export interface components { dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * @@ -21408,7 +22126,7 @@ export interface components { dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * @@ -21418,7 +22136,7 @@ export interface components { dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * @@ -21428,7 +22146,7 @@ export interface components { secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * @@ -21455,6 +22173,11 @@ export interface components { updated_at: string; /** Format: date-time */ archived_at: string | null; + /** + * @description Controls whether or not deploy keys may be added and used for repositories in the organization. + * @example false + */ + deploy_keys_enabled_for_repositories?: boolean; }; "actions-cache-usage-org-enterprise": { /** @description The count of active caches across all repositories of an enterprise or an organization. */ @@ -21541,6 +22264,31 @@ export interface components { default_workflow_permissions?: components["schemas"]["actions-default-workflow-permissions"]; can_approve_pull_request_reviews?: components["schemas"]["actions-can-approve-pull-request-reviews"]; }; + "runner-groups-org": { + id: number; + name: string; + visibility: string; + default: boolean; + /** @description Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ + selected_repositories_url?: string; + runners_url: string; + hosted_runners_url?: string; + inherited: boolean; + inherited_allows_public_repositories?: boolean; + allows_public_repositories: boolean; + /** + * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. + * @default false + */ + workflow_restrictions_read_only: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + restricted_to_workflows: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + selected_workflows?: string[]; + }; /** * Self hosted runner label * @description A label for a self hosted runner @@ -21741,9 +22489,9 @@ export interface components { "alert-instances-url": string; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} @@ -21850,7 +22598,7 @@ export interface components { * @description The type of the code security configuration. * @enum {string} */ - target_type?: "global" | "organization"; + target_type?: "global" | "organization" | "enterprise"; /** @description A description of the code security configuration */ description?: string; /** @@ -21898,6 +22646,24 @@ export interface components { * @enum {string} */ secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @enum {string} @@ -22225,8 +22991,8 @@ export interface components { inactive_this_cycle?: number; }; /** - * Copilot Business Organization Details - * @description Information about the seat breakdown and policies set for an organization with a Copilot Business subscription. + * Copilot Organization Details + * @description Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription. */ "copilot-organization-details": { seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; @@ -22255,6 +23021,11 @@ export interface components { * @enum {string} */ seat_management_setting: "assign_all" | "assign_selected" | "disabled" | "unconfigured"; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; } & { [key: string]: unknown; }; @@ -22629,6 +23400,87 @@ export interface components { created_at: string; type: string; }; + /** + * Route Stats + * @description API Insights usage route stats for an actor + */ + "api-insights-route-stats": { + /** @description The HTTP method */ + http_method?: string; + /** @description The API path's route template */ + api_route?: string; + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; + /** + * Subject Stats + * @description API Insights usage subject stats for an organization + */ + "api-insights-subject-stats": { + subject_type?: string; + subject_name?: string; + /** Format: int64 */ + subject_id?: number; + total_request_count?: number; + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; + /** + * Summary Stats + * @description API Insights usage summary stats for an organization + */ + "api-insights-summary-stats": { + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count?: number; + }; + /** + * Time Stats + * @description API Insights usage time stats for an organization + */ + "api-insights-time-stats": { + timestamp?: string; + /** Format: int64 */ + total_request_count?: number; + /** Format: int64 */ + rate_limited_request_count?: number; + }[]; + /** + * User Stats + * @description API Insights usage stats for a user + */ + "api-insights-user-stats": { + actor_type?: string; + actor_name?: string; + /** Format: int64 */ + actor_id?: number; + /** Format: int64 */ + integration_id?: number | null; + /** Format: int64 */ + oauth_application_id?: number | null; + total_request_count?: number; + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; /** * @description The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. * @example collaborators_only @@ -22933,6 +23785,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; }; /** * Package Version @@ -23021,6 +23875,10 @@ export interface components { }; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -23033,7 +23891,7 @@ export interface components { * @description Minimal representation of an organization programmatic access grant for enumerations */ "organization-programmatic-access-grant": { - /** @description Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token. */ + /** @description Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. */ id: number; owner: components["schemas"]["simple-user"]; /** @@ -23057,6 +23915,10 @@ export interface components { }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ access_granted_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -23485,7 +24347,7 @@ export interface components { allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -23893,7 +24755,8 @@ export interface components { */ actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. + * @default always * @enum {string} */ bypass_mode: "always" | "pull_request"; @@ -23963,7 +24826,9 @@ export interface components { }; /** * Organization ruleset conditions - * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. + * @description Conditions for an organization ruleset. + * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + * The push rulesets conditions object does not require the `ref_name` property. */ "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24052,6 +24917,18 @@ export interface components { /** @enum {string} */ type: "required_signatures"; }; + /** + * RequiredReviewerConfiguration + * @description A reviewing team, and file patterns describing which files they must approve changes to. + */ + "repository-rule-params-required-reviewer-configuration": { + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files. */ + file_patterns: string[]; + /** @description Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. */ + minimum_approvals: number; + /** @description Node ID of the team which must review changes to matching files. */ + reviewer_id: string; + }; /** * pull_request * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -24351,7 +25228,7 @@ export interface components { html?: { /** @description The html URL of the ruleset */ href?: string; - }; + } | null; }; conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; rules?: components["schemas"]["repository-rule"][]; @@ -26462,6 +27339,7 @@ export interface components { received_events_url?: string; type?: string; site_admin?: boolean; + user_view_type?: string; }[]; teams: { id?: number; @@ -26517,6 +27395,8 @@ export interface components { type?: string; /** @example false */ site_admin?: boolean; + /** @example public */ + user_view_type?: string; }; name?: string; client_id?: string; @@ -27067,7 +27947,10 @@ export interface components { * @description A suite of checks performed on the code of a given code change */ "check-suite": { - /** @example 5 */ + /** + * Format: int64 + * @example 5 + */ id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ node_id: string; @@ -27687,6 +28570,8 @@ export interface components { }; /** @example admin */ role_name: string; + /** @example public */ + user_view_type?: string; }; /** * Repository Invitation @@ -27802,6 +28687,8 @@ export interface components { }; /** @example admin */ role_name: string; + /** @example public */ + user_view_type?: string; } | null; /** * Repository Collaborator Permission @@ -28175,6 +29062,7 @@ export interface components { name: string; path: string; sha: string; + content?: string; /** Format: uri */ url: string; /** Format: uri */ @@ -28188,7 +29076,6 @@ export interface components { size: number; name: string; path: string; - content?: string; sha: string; /** Format: uri */ url: string; @@ -28250,7 +29137,10 @@ export interface components { * @description Content File */ "content-file": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ type: "file"; encoding: string; size: number; @@ -28284,7 +29174,10 @@ export interface components { * @description An object describing a symlink */ "content-symlink": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ type: "symlink"; target: string; size: number; @@ -28313,7 +29206,10 @@ export interface components { * @description An object describing a submodule */ "content-submodule": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ type: "submodule"; /** Format: uri */ submodule_git_url: string; @@ -28442,6 +29338,7 @@ export interface components { contributions: number; email?: string; name?: string; + user_view_type?: string; }; /** @description A Dependabot alert. */ "dependabot-alert": { @@ -28548,6 +29445,11 @@ export interface components { * @example SPDX-2.3 */ spdxVersion: string; + /** + * @description An optional comment about the SPDX document. + * @example Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/ + */ + comment?: string; creationInfo: { /** * @description The date and time the SPDX document was created. @@ -28567,11 +29469,9 @@ export interface components { * @example CC0-1.0 */ dataLicense: string; - /** @description The name of the repository that the SPDX document describes. */ - documentDescribes: string[]; /** * @description The namespace for the SPDX document. - * @example https://github.com/example/dependency_graph/sbom-123 + * @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 */ documentNamespace: string; packages: { @@ -28582,7 +29482,7 @@ export interface components { SPDXID?: string; /** * @description The name of the package. - * @example rubygems:github/github + * @example github/github */ name?: string; /** @@ -28642,6 +29542,17 @@ export interface components { referenceType: string; }[]; }[]; + relationships?: { + /** + * @description The type of relationship between the two SPDX elements. + * @example DEPENDS_ON + */ + relationshipType?: string; + /** @description The SPDX identifier of the package that is the source of the relationship. */ + spdxElementId?: string; + /** @description The SPDX identifier of the package that is the target of the relationship. */ + relatedSpdxElement?: string; + }[]; }; }; /** @@ -28797,7 +29708,7 @@ export interface components { environment: string; /** * Format: uri - * @description Deprecated: the URL to associate with this status. + * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ @@ -30159,12 +31070,12 @@ export interface components { */ path: string; /** - * @description The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. + * @description The line index in the diff to which the comment applies. This field is closing down; use `line` instead. * @example 1 */ position?: number; /** - * @description The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. + * @description The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. * @example 4 */ original_position?: number; @@ -30364,6 +31275,7 @@ export interface components { read_only: boolean; added_by?: string | null; last_used?: string | null; + enabled?: boolean; }; /** * Language @@ -30824,361 +31736,16 @@ export interface components { head: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: { - key: string; - name: string; - /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; - } | null; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; - web_commit_signoff_required?: boolean; - } | null; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - /** Format: int64 */ - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; base: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: components["schemas"]["nullable-license-simple"]; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - web_commit_signoff_required?: boolean; - }; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - /** Format: int64 */ - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; _links: { comments: components["schemas"]["link"]; @@ -31552,6 +32119,10 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + multi_repo?: boolean | null; }; /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ "secret-scanning-alert-resolution-comment": string | null; @@ -32446,6 +33017,7 @@ export interface components { company?: string | null; /** Format: date-time */ suspended_at?: string | null; + user_view_type?: string; }; /** * Private User @@ -32459,6 +33031,11 @@ export interface components { * @example 1 */ id: number; + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + user_view_type: "private"; /** @example MDQ6VXNlcjE= */ node_id: string; /** @@ -32573,8 +33150,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; business_plus?: boolean; ldap_dn?: string; }; @@ -33614,7 +34189,7 @@ export interface components { allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -33675,75 +34250,6 @@ export interface components { /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; }; - /** - * Simple User - * @description The GitHub user that triggered the event. This property is included in every webhook payload. - */ - "simple-user-webhooks": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** @example 1 */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; - /** - * Format: uri - * @example https://api.github.com/users/octocat - */ - url: string; - /** - * Format: uri - * @example https://github.com/octocat - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/followers - */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions - */ - subscriptions_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs - */ - organizations_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/repos - */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events - */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - }; /** * branch protection rule * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. @@ -33916,6 +34422,7 @@ export interface components { /** Format: uri */ url: string; verified: boolean; + enabled?: boolean; }; /** Workflow */ webhooks_workflow: { @@ -33954,6 +34461,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; webhooks_reviewers: { /** User */ @@ -34043,6 +34551,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; webhooks_answer: { /** @@ -34114,6 +34623,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -34159,6 +34669,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; answer_html_url: string | null; /** @@ -34258,6 +34769,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; labels?: components["schemas"]["label"][]; }; @@ -34329,6 +34841,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Label */ @@ -34458,6 +34971,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The changes to the comment. */ @@ -34510,6 +35024,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -34546,6 +35061,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -34633,6 +35149,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -34715,6 +35232,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -34876,6 +35394,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -34924,6 +35443,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -34992,6 +35512,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -35028,6 +35549,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -35115,6 +35637,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -35197,6 +35720,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -35358,6 +35882,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** User */ @@ -35396,6 +35921,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Marketplace Purchase */ webhooks_marketplace_purchase: { @@ -35975,7 +36501,7 @@ export interface components { allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -36082,6 +36608,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36155,6 +36682,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -36221,6 +36749,10 @@ export interface components { }[] | null; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -36276,6 +36808,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -36332,6 +36865,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ html_url: string; @@ -36551,7 +37085,7 @@ export interface components { */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ use_squash_pr_title_as_default: boolean; @@ -36639,6 +37173,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36727,6 +37262,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -36950,6 +37486,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -37059,6 +37596,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -37294,6 +37832,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -37403,6 +37942,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -37470,6 +38010,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -37517,6 +38058,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -37740,6 +38282,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -37886,6 +38429,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The review that was affected. */ @@ -37959,6 +38503,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; webhooks_nullable_string: string | null; @@ -38065,6 +38610,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -38212,6 +38758,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -38361,6 +38908,10 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + multi_repo?: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { @@ -38421,6 +38972,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; node_id: string; privacy_level: string; @@ -38460,6 +39012,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** User */ sponsorable: { @@ -38497,6 +39050,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Sponsorship Tier @@ -38608,7 +39162,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection configuration enabled event */ "webhook-branch-protection-configuration-enabled": { @@ -38618,7 +39172,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule created event */ "webhook-branch-protection-rule-created": { @@ -38629,7 +39183,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ "webhook-branch-protection-rule-deleted": { @@ -38640,7 +39194,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ "webhook-branch-protection-rule-edited": { @@ -38691,7 +39245,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ "webhook-check-run-completed": { @@ -38701,7 +39255,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event @@ -38719,7 +39273,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event @@ -38742,7 +39296,7 @@ export interface components { /** @description The integrator reference of the action requested by the user. */ identifier?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event @@ -38760,7 +39314,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event @@ -38834,6 +39388,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39011,7 +39566,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite requested event */ "webhook-check-suite-requested": { @@ -39077,6 +39632,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39254,7 +39810,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite rerequested event */ "webhook-check-suite-rerequested": { @@ -39320,6 +39876,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39497,7 +40054,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert appeared_in_branch event */ "webhook-code-scanning-alert-appeared-in-branch": { @@ -39551,6 +40108,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -39623,7 +40181,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ "webhook-code-scanning-alert-closed-by-user": { @@ -39677,6 +40235,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -39756,7 +40315,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ "webhook-code-scanning-alert-created": { @@ -39831,9 +40390,9 @@ export interface components { }; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - state: "open" | "dismissed"; + state: "open" | "dismissed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -39851,7 +40410,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ "webhook-code-scanning-alert-fixed": { @@ -39905,6 +40464,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -39986,7 +40546,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ "webhook-code-scanning-alert-reopened": { @@ -40079,7 +40639,7 @@ export interface components { /** @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. */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ "webhook-code-scanning-alert-reopened-by-user": { @@ -40163,7 +40723,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** commit_comment created event */ "webhook-commit-comment-created": { @@ -40172,7 +40732,7 @@ export interface components { * @enum {string} */ action: "created"; - /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ + /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ comment: { /** * AuthorAssociation @@ -40251,13 +40811,14 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** create event */ "webhook-create": { @@ -40276,7 +40837,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** custom property created event */ "webhook-custom-property-created": { @@ -40286,7 +40847,7 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property deleted event */ "webhook-custom-property-deleted": { @@ -40299,7 +40860,7 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property updated event */ "webhook-custom-property-updated": { @@ -40309,7 +40870,7 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Custom property values updated event */ "webhook-custom-property-values-updated": { @@ -40319,7 +40880,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; repository: components["schemas"]["repository-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description The new custom property values for the repository. */ new_property_values: components["schemas"]["custom-property-value"][]; /** @description The old custom property values for the repository. */ @@ -40338,7 +40899,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-dismissed event */ "webhook-dependabot-alert-auto-dismissed": { @@ -40349,7 +40910,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-reopened event */ "webhook-dependabot-alert-auto-reopened": { @@ -40360,7 +40921,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ "webhook-dependabot-alert-created": { @@ -40371,7 +40932,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ "webhook-dependabot-alert-dismissed": { @@ -40382,7 +40943,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ "webhook-dependabot-alert-fixed": { @@ -40393,7 +40954,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ "webhook-dependabot-alert-reintroduced": { @@ -40404,7 +40965,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ "webhook-dependabot-alert-reopened": { @@ -40415,7 +40976,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ "webhook-deploy-key-created": { @@ -40426,7 +40987,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ "webhook-deploy-key-deleted": { @@ -40437,7 +40998,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deployment created event */ "webhook-deployment-created": { @@ -40485,6 +41046,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -40547,6 +41109,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40643,7 +41206,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run: { @@ -40683,6 +41246,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -40917,6 +41481,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -40944,7 +41509,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; installation?: components["schemas"]["simple-installation"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-deployment-review-approved": { /** @enum {string} */ @@ -40956,7 +41521,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -41007,6 +41572,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -41075,6 +41641,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -41185,6 +41752,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -41241,6 +41809,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -41260,7 +41829,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -41311,6 +41880,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -41378,6 +41948,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -41488,6 +42059,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -41544,6 +42116,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -41600,11 +42173,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @enum {string} */ type?: "User" | "Team"; }[]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { conclusion: unknown; @@ -41654,6 +42228,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -41721,6 +42296,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -41831,6 +42407,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -41887,6 +42464,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -41973,6 +42551,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -42035,6 +42614,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42166,6 +42746,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ deployment_url: string; @@ -42233,6 +42814,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42326,7 +42908,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run?: { @@ -42366,6 +42948,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -42600,6 +43183,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -42619,7 +43203,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion category changed event */ "webhook-discussion-category-changed": { @@ -42647,7 +43231,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion closed event */ "webhook-discussion-closed": { @@ -42658,7 +43242,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment created event */ "webhook-discussion-comment-created": { @@ -42670,7 +43254,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment deleted event */ "webhook-discussion-comment-deleted": { @@ -42682,7 +43266,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment edited event */ "webhook-discussion-comment-edited": { @@ -42699,7 +43283,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion created event */ "webhook-discussion-created": { @@ -42710,7 +43294,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion deleted event */ "webhook-discussion-deleted": { @@ -42721,7 +43305,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion edited event */ "webhook-discussion-edited": { @@ -42740,7 +43324,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion labeled event */ "webhook-discussion-labeled": { @@ -42752,7 +43336,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ "webhook-discussion-locked": { @@ -42763,7 +43347,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion pinned event */ "webhook-discussion-pinned": { @@ -42774,7 +43358,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion reopened event */ "webhook-discussion-reopened": { @@ -42785,7 +43369,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion transferred event */ "webhook-discussion-transferred": { @@ -42800,7 +43384,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unanswered event */ "webhook-discussion-unanswered": { @@ -42810,7 +43394,7 @@ export interface components { old_answer: components["schemas"]["webhooks_answer"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ "webhook-discussion-unlabeled": { @@ -42822,7 +43406,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ "webhook-discussion-unlocked": { @@ -42833,7 +43417,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unpinned event */ "webhook-discussion-unpinned": { @@ -42844,7 +43428,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * fork event @@ -43040,6 +43624,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -43191,13 +43776,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ "webhook-github-app-authorization-revoked": { /** @enum {string} */ action: "revoked"; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** gollum event */ "webhook-gollum": { @@ -43225,7 +43810,7 @@ export interface components { title: string; }[]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation created event */ "webhook-installation-created": { @@ -43237,7 +43822,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ "webhook-installation-deleted": { @@ -43249,7 +43834,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ "webhook-installation-new-permissions-accepted": { @@ -43261,7 +43846,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ "webhook-installation-repositories-added": { @@ -43285,7 +43870,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ "webhook-installation-repositories-removed": { @@ -43309,7 +43894,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ "webhook-installation-suspend": { @@ -43321,7 +43906,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { @@ -43361,6 +43946,7 @@ export interface components { updated_at?: string; url?: string; website_url?: unknown; + user_view_type?: string; }; /** @enum {string} */ action: "renamed"; @@ -43376,7 +43962,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; target_type: string; }; /** installation unsuspend event */ @@ -43389,7 +43975,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ "webhook-issue-comment-created": { @@ -43479,6 +44065,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -43523,6 +44110,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -43559,6 +44147,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -43646,6 +44235,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -43728,6 +44318,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -43889,6 +44480,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -43928,6 +44520,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: Record[]; author_association?: string; @@ -44006,7 +44599,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ "webhook-issue-comment-deleted": { @@ -44055,6 +44648,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -44091,6 +44685,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -44178,6 +44773,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -44260,6 +44856,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -44421,6 +45018,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -44460,6 +45058,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: Record[]; author_association?: string; @@ -44534,11 +45133,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment edited event */ "webhook-issue-comment-edited": { @@ -44588,6 +45188,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -44624,6 +45225,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -44711,6 +45313,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -44793,6 +45396,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -44954,6 +45558,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -44993,6 +45598,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: Record[]; author_association?: string; @@ -45071,7 +45677,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues assigned event */ "webhook-issues-assigned": { @@ -45086,7 +45692,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues closed event */ "webhook-issues-closed": { @@ -45137,6 +45743,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -45173,6 +45780,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -45260,6 +45868,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -45342,6 +45951,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -45503,6 +46113,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -45563,11 +46174,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues deleted event */ "webhook-issues-deleted": { @@ -45618,6 +46230,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -45741,6 +46354,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -45823,6 +46437,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -45984,11 +46599,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues demilestoned event */ "webhook-issues-demilestoned": { @@ -46162,6 +46778,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -46244,6 +46861,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -46405,12 +47023,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues edited event */ "webhook-issues-edited": { @@ -46472,6 +47091,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46595,6 +47215,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -46677,6 +47298,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -46838,12 +47460,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues labeled event */ "webhook-issues-labeled": { @@ -46894,6 +47517,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47017,6 +47641,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -47099,6 +47724,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -47260,12 +47886,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues locked event */ "webhook-issues-locked": { @@ -47316,6 +47943,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47352,6 +47980,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47440,6 +48069,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -47522,6 +48152,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -47683,11 +48314,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ "webhook-issues-milestoned": { @@ -47861,6 +48493,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -47943,6 +48576,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -48104,12 +48738,13 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues opened event */ "webhook-issues-opened": { @@ -48159,6 +48794,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48195,6 +48831,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48282,6 +48919,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -48364,6 +49002,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -48525,6 +49164,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } | null; /** @@ -48724,6 +49364,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -48819,6 +49460,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48855,6 +49497,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48942,6 +49585,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49024,6 +49668,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -49185,11 +49830,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ "webhook-issues-pinned": { @@ -49200,7 +49846,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ "webhook-issues-reopened": { @@ -49374,6 +50020,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49456,6 +50103,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -49617,11 +50265,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ "webhook-issues-transferred": { @@ -49671,6 +50320,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -49707,6 +50357,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -49794,6 +50445,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49876,6 +50528,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -50037,6 +50690,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -50239,6 +50893,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50294,7 +50949,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ "webhook-issues-unassigned": { @@ -50309,7 +50964,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ "webhook-issues-unlabeled": { @@ -50321,7 +50976,7 @@ export interface components { label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ "webhook-issues-unlocked": { @@ -50372,6 +51027,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -50408,6 +51064,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -50496,6 +51153,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -50578,6 +51236,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -50739,11 +51398,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ "webhook-issues-unpinned": { @@ -50754,7 +51414,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label created event */ "webhook-label-created": { @@ -50765,7 +51425,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ "webhook-label-deleted": { @@ -50776,7 +51436,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label edited event */ "webhook-label-edited": { @@ -50802,7 +51462,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase cancelled event */ "webhook-marketplace-purchase-cancelled": { @@ -50815,7 +51475,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase changed event */ "webhook-marketplace-purchase-changed": { @@ -50854,7 +51514,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change event */ "webhook-marketplace-purchase-pending-change": { @@ -50893,7 +51553,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change_cancelled event */ "webhook-marketplace-purchase-pending-change-cancelled": { @@ -50932,7 +51592,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase purchased event */ "webhook-marketplace-purchase-purchased": { @@ -50945,7 +51605,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member added event */ "webhook-member-added": { @@ -50970,7 +51630,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member edited event */ "webhook-member-edited": { @@ -50992,7 +51652,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member removed event */ "webhook-member-removed": { @@ -51003,7 +51663,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** membership added event */ "webhook-membership-added": { @@ -51055,6 +51715,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -51108,6 +51769,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -51118,7 +51780,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-merge-group-destroyed": { /** @enum {string} */ @@ -51132,7 +51794,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** meta deleted event */ "webhook-meta-deleted": { @@ -51162,7 +51824,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ "webhook-milestone-closed": { @@ -51173,7 +51835,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone created event */ "webhook-milestone-created": { @@ -51184,7 +51846,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ "webhook-milestone-deleted": { @@ -51195,7 +51857,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ "webhook-milestone-edited": { @@ -51221,7 +51883,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ "webhook-milestone-opened": { @@ -51232,7 +51894,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block blocked event */ "webhook-org-block-blocked": { @@ -51243,7 +51905,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block unblocked event */ "webhook-org-block-unblocked": { @@ -51254,7 +51916,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization deleted event */ "webhook-organization-deleted": { @@ -51265,7 +51927,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ "webhook-organization-member-added": { @@ -51276,7 +51938,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ "webhook-organization-member-invited": { @@ -51331,6 +51993,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; login: string | null; node_id: string; @@ -51340,7 +52003,7 @@ export interface components { }; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ @@ -51352,7 +52015,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ "webhook-organization-renamed": { @@ -51368,7 +52031,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ "webhook-rubygems-metadata": { @@ -51442,6 +52105,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -51481,6 +52145,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body?: string | Record; body_html?: string; @@ -51609,6 +52274,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -51644,7 +52310,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** package updated event */ "webhook-package-updated": { @@ -51699,6 +52365,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -51738,6 +52405,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string; body_html: string; @@ -51809,6 +52477,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -51845,7 +52514,7 @@ export interface components { updated_at: string; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** page_build event */ "webhook-page-build": { @@ -51893,6 +52562,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; status: string; updated_at: string; @@ -51904,7 +52574,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** personal_access_token_request approved event */ "webhook-personal-access-token-request-approved": { @@ -51913,7 +52583,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request cancelled event */ @@ -51923,7 +52593,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request created event */ @@ -51933,7 +52603,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation?: components["schemas"]["simple-installation"]; }; /** personal_access_token_request denied event */ @@ -51943,7 +52613,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; organization: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; "webhook-ping": { @@ -51990,7 +52660,7 @@ export interface components { hook_id?: number; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ zen?: string; }; @@ -52013,7 +52683,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card created event */ "webhook-project-card-created": { @@ -52024,7 +52694,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ "webhook-project-card-deleted": { @@ -52081,6 +52751,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -52094,7 +52765,7 @@ export interface components { url: string; }; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ "webhook-project-card-edited": { @@ -52110,7 +52781,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ "webhook-project-card-moved": { @@ -52171,6 +52842,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -52216,7 +52888,7 @@ export interface components { url?: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project closed event */ "webhook-project-closed": { @@ -52227,7 +52899,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_column created event */ "webhook-project-column-created": { @@ -52238,7 +52910,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ "webhook-project-column-deleted": { @@ -52249,7 +52921,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ "webhook-project-column-edited": { @@ -52265,7 +52937,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ "webhook-project-column-moved": { @@ -52276,7 +52948,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project created event */ "webhook-project-created": { @@ -52287,7 +52959,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project deleted event */ "webhook-project-deleted": { @@ -52298,7 +52970,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project edited event */ "webhook-project-edited": { @@ -52320,7 +52992,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ "webhook-project-reopened": { @@ -52331,7 +53003,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ "webhook-projects-v2-project-closed": { @@ -52340,7 +53012,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ "webhook-projects-v2-project-created": { @@ -52349,7 +53021,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ "webhook-projects-v2-project-deleted": { @@ -52358,7 +53030,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ "webhook-projects-v2-project-edited": { @@ -52385,7 +53057,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ "webhook-projects-v2-item-archived": { @@ -52395,7 +53067,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ "webhook-projects-v2-item-converted": { @@ -52410,7 +53082,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ "webhook-projects-v2-item-created": { @@ -52419,7 +53091,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ "webhook-projects-v2-item-deleted": { @@ -52428,7 +53100,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ "webhook-projects-v2-item-edited": { @@ -52454,7 +53126,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ "webhook-projects-v2-item-reordered": { @@ -52469,7 +53141,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ "webhook-projects-v2-item-restored": { @@ -52479,7 +53151,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ "webhook-projects-v2-project-reopened": { @@ -52488,7 +53160,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Created Event */ "webhook-projects-v2-status-update-created": { @@ -52497,7 +53169,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Deleted Event */ "webhook-projects-v2-status-update-deleted": { @@ -52506,7 +53178,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Edited Event */ "webhook-projects-v2-status-update-edited": { @@ -52539,7 +53211,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** public event */ "webhook-public": { @@ -52547,7 +53219,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request assigned event */ "webhook-pull-request-assigned": { @@ -52641,6 +53313,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -52677,6 +53350,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -52729,6 +53403,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -52952,6 +53627,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53012,7 +53688,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -53061,6 +53737,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -53296,6 +53973,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53356,7 +54034,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -53405,6 +54083,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -53472,6 +54151,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -53519,6 +54199,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -53585,6 +54266,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -53742,10 +54424,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ "webhook-pull-request-auto-merge-disabled": { @@ -53838,6 +54521,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -53926,6 +54610,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -54149,6 +54834,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54209,7 +54895,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -54258,6 +54944,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -54493,6 +55180,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54553,7 +55241,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -54602,6 +55290,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -54669,6 +55358,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -54716,6 +55406,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -54782,6 +55473,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -54939,11 +55631,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ "webhook-pull-request-auto-merge-enabled": { @@ -55036,6 +55729,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -55124,6 +55818,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -55347,6 +56042,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55407,7 +56103,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -55456,6 +56152,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -55688,6 +56385,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55748,7 +56446,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -55797,6 +56495,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -55864,6 +56563,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -55911,6 +56611,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -55977,6 +56678,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -56134,11 +56836,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason?: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ "webhook-pull-request-closed": { @@ -56150,7 +56853,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ "webhook-pull-request-converted-to-draft": { @@ -56162,7 +56865,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ "webhook-pull-request-demilestoned": { @@ -56174,7 +56877,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request dequeued event */ "webhook-pull-request-dequeued": { @@ -56267,6 +56970,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -56355,6 +57059,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -56578,6 +57283,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56638,7 +57344,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -56687,6 +57393,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -56922,6 +57629,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56982,7 +57690,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -57031,6 +57739,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -57098,6 +57807,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -57145,6 +57855,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -57211,6 +57922,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -57368,11 +58080,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - reason: string; + /** @enum {string} */ + reason: "UNKNOWN_REMOVAL_REASON" | "MANUAL" | "MERGE" | "MERGE_CONFLICT" | "CI_FAILURE" | "CI_TIMEOUT" | "ALREADY_MERGED" | "QUEUE_CLEARED" | "ROLL_BACK" | "BRANCH_PROTECTIONS" | "GIT_TREE_INVALID" | "INVALID_MERGE_COMMIT"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request edited event */ "webhook-pull-request-edited": { @@ -57403,7 +58117,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request enqueued event */ "webhook-pull-request-enqueued": { @@ -57496,6 +58210,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -57584,6 +58299,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -57807,6 +58523,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57867,7 +58584,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -57916,6 +58633,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -58151,6 +58869,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58211,7 +58930,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -58260,6 +58979,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -58327,6 +59047,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -58374,6 +59095,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -58440,6 +59162,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -58597,10 +59320,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ "webhook-pull-request-labeled": { @@ -58694,6 +59418,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -58782,6 +59507,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -59005,6 +59731,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59065,7 +59792,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -59114,6 +59841,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -59349,6 +60077,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59409,7 +60138,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -59458,6 +60187,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -59525,6 +60255,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -59572,6 +60303,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -59638,6 +60370,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -59795,10 +60528,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ "webhook-pull-request-locked": { @@ -59891,6 +60625,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -59979,6 +60714,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -60202,6 +60938,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60262,7 +60999,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -60311,6 +61048,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -60546,6 +61284,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60606,7 +61345,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -60655,6 +61394,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -60722,6 +61462,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -60769,6 +61510,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -60835,6 +61577,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -60992,10 +61735,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ "webhook-pull-request-milestoned": { @@ -61007,7 +61751,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ "webhook-pull-request-opened": { @@ -61019,7 +61763,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ "webhook-pull-request-ready-for-review": { @@ -61031,7 +61775,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ "webhook-pull-request-reopened": { @@ -61043,7 +61787,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ "webhook-pull-request-review-comment-created": { @@ -61193,6 +61937,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -61279,6 +62024,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -61367,6 +62113,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -61590,6 +62337,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61650,7 +62398,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -61699,6 +62447,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -61927,6 +62676,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61987,7 +62737,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -62036,6 +62786,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -62107,6 +62858,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -62171,6 +62923,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -62322,10 +63075,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ "webhook-pull-request-review-comment-deleted": { @@ -62416,6 +63170,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -62504,6 +63259,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -62727,6 +63483,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62787,7 +63544,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -62836,6 +63593,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -63064,6 +63822,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63124,7 +63883,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -63173,6 +63932,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -63244,6 +64004,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -63308,6 +64069,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -63459,10 +64221,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ "webhook-pull-request-review-comment-edited": { @@ -63554,6 +64317,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -63590,6 +64354,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -63642,6 +64407,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -63865,6 +64631,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63925,7 +64692,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -63974,6 +64741,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -64202,6 +64970,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64262,7 +65031,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -64311,6 +65080,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -64382,6 +65152,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -64446,6 +65217,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -64595,12 +65367,13 @@ export interface components { subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; + user_view_type?: string; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ "webhook-pull-request-review-dismissed": { @@ -64691,6 +65464,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -64779,6 +65553,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -65002,6 +65777,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65062,7 +65838,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -65111,6 +65887,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -65339,6 +66116,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65399,7 +66177,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -65448,6 +66226,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -65519,6 +66298,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -65583,6 +66363,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -65734,6 +66515,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -65809,9 +66591,10 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ "webhook-pull-request-review-edited": { @@ -65908,6 +66691,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -65996,6 +66780,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -66197,6 +66982,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66282,6 +67068,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -66488,6 +67275,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66573,6 +67361,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -66644,6 +67433,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -66708,6 +67498,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -66859,11 +67650,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ "webhook-pull-request-review-request-removed": { @@ -66957,6 +67749,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -66993,6 +67786,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -67045,6 +67839,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -67268,6 +68063,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67321,7 +68117,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -67370,6 +68166,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -67605,6 +68402,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67665,7 +68463,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -67714,6 +68512,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -67781,6 +68580,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -67828,6 +68628,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -67894,6 +68695,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -68051,6 +68853,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -68090,8 +68893,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ action: "review_request_removed"; @@ -68183,6 +68987,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -68219,6 +69024,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -68271,6 +69077,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -68494,6 +69301,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68554,7 +69362,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -68603,6 +69411,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -68838,6 +69647,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68898,7 +69708,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -68947,6 +69757,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -69014,6 +69825,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -69061,6 +69873,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -69127,6 +69940,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -69284,6 +70098,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -69342,7 +70157,7 @@ export interface components { */ url: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_requested event */ "webhook-pull-request-review-requested": { @@ -69436,6 +70251,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -69472,6 +70288,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -69524,6 +70341,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -69747,6 +70565,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69807,7 +70626,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -69856,6 +70675,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -70091,6 +70911,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -70151,7 +70972,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -70200,6 +71021,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -70267,6 +71089,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -70314,6 +71137,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -70380,6 +71204,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -70537,6 +71362,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -70576,8 +71402,9 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ action: "review_requested"; @@ -70669,6 +71496,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -70705,6 +71533,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -70757,6 +71586,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -70980,6 +71810,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71040,7 +71871,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -71089,6 +71920,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -71324,6 +72156,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71384,7 +72217,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -71433,6 +72266,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -71500,6 +72334,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -71547,6 +72382,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -71613,6 +72449,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -71770,6 +72607,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -71828,7 +72666,7 @@ export interface components { */ url?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review submitted event */ "webhook-pull-request-review-submitted": { @@ -71919,6 +72757,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -72007,6 +72846,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -72230,6 +73070,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72290,7 +73131,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -72339,6 +73180,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -72567,6 +73409,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72627,7 +73470,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -72676,6 +73519,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -72747,6 +73591,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -72811,6 +73656,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -72962,11 +73808,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ "webhook-pull-request-review-thread-resolved": { @@ -73057,6 +73904,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -73145,6 +73993,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -73351,6 +74200,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73438,6 +74288,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -73649,6 +74500,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73736,6 +74588,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -73807,6 +74660,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -73871,6 +74725,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -74022,10 +74877,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -74167,6 +75023,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -74261,6 +75118,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -74349,6 +75207,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -74555,6 +75414,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -74642,6 +75502,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -74853,6 +75714,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -74940,6 +75802,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -75011,6 +75874,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -75075,6 +75939,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -75226,10 +76091,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -75371,6 +76237,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -75469,6 +76336,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -75557,6 +76425,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -75780,6 +76649,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -75840,7 +76710,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -75889,6 +76759,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -76117,6 +76988,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -76177,7 +77049,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -76226,6 +77098,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -76293,6 +77166,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -76340,6 +77214,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -76406,6 +77281,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -76563,10 +77439,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ "webhook-pull-request-unassigned": { @@ -76660,6 +77537,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -76748,6 +77626,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -76971,6 +77850,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -77031,7 +77911,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -77080,6 +77960,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -77315,6 +78196,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -77375,7 +78257,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -77424,6 +78306,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -77491,6 +78374,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -77538,6 +78422,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -77604,6 +78489,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -77761,10 +78647,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ "webhook-pull-request-unlabeled": { @@ -77858,6 +78745,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -77946,6 +78834,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -78169,6 +79058,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -78229,7 +79119,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -78278,6 +79168,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -78506,6 +79397,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -78566,7 +79458,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -78615,6 +79507,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -78682,6 +79575,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -78729,6 +79623,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -78795,6 +79690,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -78952,10 +79848,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ "webhook-pull-request-unlocked": { @@ -79048,6 +79945,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -79136,6 +80034,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -79359,6 +80258,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -79419,7 +80319,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -79468,6 +80368,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -79703,6 +80604,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -79763,7 +80665,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -79812,6 +80714,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -79879,6 +80782,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -79926,6 +80830,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -79992,6 +80897,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -80149,10 +81055,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** push event */ "webhook-push": { @@ -80489,6 +81396,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -80538,7 +81446,7 @@ export interface components { /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-registry-package-published": { /** @enum {string} */ @@ -80573,6 +81481,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -80595,6 +81504,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body?: string | Record; body_html?: string; @@ -80704,6 +81614,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; created_at?: string; draft?: boolean; @@ -80734,7 +81645,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-registry-package-updated": { /** @enum {string} */ @@ -80769,6 +81680,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -80791,6 +81703,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body: string; body_html: string; @@ -80843,6 +81756,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; created_at: string; draft: boolean; @@ -80867,7 +81781,7 @@ export interface components { updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release created event */ "webhook-release-created": { @@ -80878,7 +81792,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release deleted event */ "webhook-release-deleted": { @@ -80889,7 +81803,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release edited event */ "webhook-release-edited": { @@ -80914,7 +81828,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ "webhook-release-prereleased": { @@ -81026,6 +81940,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -81074,7 +81989,7 @@ export interface components { zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release published event */ "webhook-release-published": { @@ -81085,7 +82000,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release released event */ "webhook-release-released": { @@ -81096,7 +82011,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ "webhook-release-unpublished": { @@ -81107,7 +82022,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory published event */ "webhook-repository-advisory-published": { @@ -81118,7 +82033,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory reported event */ "webhook-repository-advisory-reported": { @@ -81129,7 +82044,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ "webhook-repository-archived": { @@ -81139,7 +82054,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository created event */ "webhook-repository-created": { @@ -81149,7 +82064,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository deleted event */ "webhook-repository-deleted": { @@ -81159,7 +82074,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { @@ -81174,7 +82089,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository edited event */ "webhook-repository-edited": { @@ -81198,7 +82113,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_import event */ "webhook-repository-import": { @@ -81206,7 +82121,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @enum {string} */ status: "success" | "cancelled" | "failure"; }; @@ -81218,7 +82133,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository publicized event */ "webhook-repository-publicized": { @@ -81228,7 +82143,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository renamed event */ "webhook-repository-renamed": { @@ -81245,7 +82160,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset created event */ "webhook-repository-ruleset-created": { @@ -81256,7 +82171,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset deleted event */ "webhook-repository-ruleset-deleted": { @@ -81267,7 +82182,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset edited event */ "webhook-repository-ruleset-edited": { @@ -81325,7 +82240,7 @@ export interface components { }[]; }; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ "webhook-repository-transferred": { @@ -81396,6 +82311,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; }; @@ -81404,7 +82320,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository unarchived event */ "webhook-repository-unarchived": { @@ -81414,7 +82330,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert create event */ "webhook-repository-vulnerability-alert-create": { @@ -81425,7 +82341,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert dismiss event */ "webhook-repository-vulnerability-alert-dismiss": { @@ -81478,6 +82394,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; external_identifier: string; /** Format: uri */ @@ -81498,7 +82415,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert reopen event */ "webhook-repository-vulnerability-alert-reopen": { @@ -81509,7 +82426,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert resolve event */ "webhook-repository-vulnerability-alert-resolve": { @@ -81581,7 +82498,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** secret_scanning_alert created event */ "webhook-secret-scanning-alert-created": { @@ -81592,7 +82509,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created": { @@ -81603,13 +82520,24 @@ export interface components { location: components["schemas"]["secret-scanning-location"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created-form-encoded": { /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ payload: string; }; + /** secret_scanning_alert publicly leaked event */ + "webhook-secret-scanning-alert-publicly-leaked": { + /** @enum {string} */ + action: "publicly_leaked"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** secret_scanning_alert reopened event */ "webhook-secret-scanning-alert-reopened": { /** @enum {string} */ @@ -81619,7 +82547,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert resolved event */ "webhook-secret-scanning-alert-resolved": { @@ -81630,7 +82558,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert validated event */ "webhook-secret-scanning-alert-validated": { @@ -81641,7 +82569,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ "webhook-security-advisory-published": { @@ -81652,7 +82580,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ "webhook-security-advisory-updated": { @@ -81663,7 +82591,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ "webhook-security-advisory-withdrawn": { @@ -81711,7 +82639,7 @@ export interface components { }[]; withdrawn_at: string; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ "webhook-security-and-analysis": { @@ -81724,7 +82652,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["full-repository"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ "webhook-sponsorship-cancelled": { @@ -81734,7 +82662,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ @@ -81745,7 +82673,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ @@ -81762,7 +82690,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ @@ -81774,7 +82702,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ @@ -81787,7 +82715,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ @@ -81799,7 +82727,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ @@ -81810,7 +82738,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: string | null; }; @@ -81822,7 +82750,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: unknown; }; @@ -81986,7 +82914,7 @@ export interface components { name: string; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ sha: string; /** @@ -82012,7 +82940,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** parent issue removed event */ "webhook-sub-issues-parent-issue-removed": { @@ -82028,7 +82956,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sub-issue added event */ "webhook-sub-issues-sub-issue-added": { @@ -82044,7 +82972,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sub-issue removed event */ "webhook-sub-issues-sub-issue-removed": { @@ -82060,7 +82988,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** team_add event */ "webhook-team-add": { @@ -82068,7 +82996,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ @@ -82273,6 +83201,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -82320,7 +83249,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ @@ -82525,6 +83454,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -82572,7 +83502,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ @@ -82777,6 +83707,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -82824,7 +83755,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ @@ -83060,6 +83991,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -83107,7 +84039,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ @@ -83312,6 +84244,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -83359,7 +84292,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ @@ -83370,7 +84303,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** workflow_dispatch event */ "webhook-workflow-dispatch": { @@ -83382,7 +84315,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: string; }; /** workflow_job completed event */ @@ -83393,7 +84326,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -83483,7 +84416,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -83581,7 +84514,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -83635,7 +84568,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -83689,7 +84622,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -83729,6 +84662,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -83879,6 +84813,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -84051,6 +84986,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -84119,6 +85055,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -84142,7 +85079,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -84590,7 +85527,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -84630,6 +85567,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -84780,6 +85718,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -84952,6 +85891,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -85020,6 +85960,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -85113,6 +86054,15 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + usage_metrics_api_disabled: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Service unavailable */ service_unavailable: { headers: { @@ -85361,6 +86311,12 @@ export interface components { "secret-scanning-alert-sort": "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ "secret-scanning-alert-validity": string; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + "secret-scanning-alert-publicly-leaked": boolean; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + "secret-scanning-alert-multi-repo": boolean; + /** @description The slug of the enterprise team name. */ + "enterprise-team-slug": string; /** @description The slug of the team name. */ "team-slug": string; /** @description The unique identifier of the gist. */ @@ -85393,6 +86349,10 @@ export interface components { org: string; /** @description The unique identifier of the repository. */ "repository-id": number; + /** @description Only return runner groups that are allowed to be used by this repository. */ + "visible-to-repository": string; + /** @description Unique identifier of the self-hosted runner group. */ + "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ "runner-id": number; /** @description The name of a self-hosted runner's custom label. */ @@ -85413,6 +86373,22 @@ export interface components { "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; + /** @description The type of the actor */ + "api-insights-actor-type": "installations" | "classic_pats" | "fine_grained_pats" | "oauth_apps" | "github_apps_user_to_server"; + /** @description The ID of the actor */ + "api-insights-actor-id": number; + /** @description The minimum timestamp to query for stats */ + "api-insights-min-timestamp": string; + /** @description The maximum timestamp to query for stats */ + "api-insights-max-timestamp": string; + /** @description The property to sort the results by. */ + "api-insights-route-stats-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[]; + /** @description The property to sort the results by. */ + "api-insights-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[]; + /** @description The ID of the user to query for stats */ + "api-insights-user-id": string; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + "api-insights-timestamp-increment": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The name of the codespace. */ @@ -85448,8 +86424,13 @@ export interface components { "personal-access-token-after": string; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ "custom-property-name": string; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + "ruleset-targets": string; /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ @@ -85542,6 +86523,8 @@ export interface components { status: "queued" | "in_progress" | "completed"; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ "git-ref": components["schemas"]["code-scanning-ref"]; + /** @description The number of the pull request for the results you want to list. */ + "pr-alias": number; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -85671,11 +86654,16 @@ export type SchemaSimpleClassroomAssignment = components['schemas']['simple-clas export type SchemaClassroomAcceptedAssignment = components['schemas']['classroom-accepted-assignment']; export type SchemaClassroomAssignmentGrade = components['schemas']['classroom-assignment-grade']; export type SchemaCodeOfConduct = components['schemas']['code-of-conduct']; -export type SchemaOrganizationSimple = components['schemas']['organization-simple']; +export type SchemaNullableOrganizationSimple = components['schemas']['nullable-organization-simple']; export type SchemaNullableTeamSimple = components['schemas']['nullable-team-simple']; export type SchemaTeam = components['schemas']['team']; export type SchemaEnterpriseTeam = components['schemas']['enterprise-team']; export type SchemaCopilotSeatDetails = components['schemas']['copilot-seat-details']; +export type SchemaCopilotIdeCodeCompletions = components['schemas']['copilot-ide-code-completions']; +export type SchemaCopilotIdeChat = components['schemas']['copilot-ide-chat']; +export type SchemaCopilotDotcomChat = components['schemas']['copilot-dotcom-chat']; +export type SchemaCopilotDotcomPullRequests = components['schemas']['copilot-dotcom-pull-requests']; +export type SchemaCopilotUsageMetricsDay = components['schemas']['copilot-usage-metrics-day']; export type SchemaCopilotUsageMetrics = components['schemas']['copilot-usage-metrics']; export type SchemaAlertNumber = components['schemas']['alert-number']; export type SchemaDependabotAlertPackage = components['schemas']['dependabot-alert-package']; @@ -85720,6 +86708,7 @@ export type SchemaSecurityAndAnalysis = components['schemas']['security-and-anal export type SchemaMinimalRepository = components['schemas']['minimal-repository']; export type SchemaThread = components['schemas']['thread']; export type SchemaThreadSubscription = components['schemas']['thread-subscription']; +export type SchemaOrganizationSimple = components['schemas']['organization-simple']; export type SchemaOrganizationFull = components['schemas']['organization-full']; export type SchemaActionsCacheUsageOrgEnterprise = components['schemas']['actions-cache-usage-org-enterprise']; export type SchemaActionsCacheUsageByRepository = components['schemas']['actions-cache-usage-by-repository']; @@ -85734,6 +86723,7 @@ export type SchemaActionsDefaultWorkflowPermissions = components['schemas']['act export type SchemaActionsCanApprovePullRequestReviews = components['schemas']['actions-can-approve-pull-request-reviews']; export type SchemaActionsGetDefaultWorkflowPermissions = components['schemas']['actions-get-default-workflow-permissions']; export type SchemaActionsSetDefaultWorkflowPermissions = components['schemas']['actions-set-default-workflow-permissions']; +export type SchemaRunnerGroupsOrg = components['schemas']['runner-groups-org']; export type SchemaRunnerLabel = components['schemas']['runner-label']; export type SchemaRunner = components['schemas']['runner']; export type SchemaRunnerApplication = components['schemas']['runner-application']; @@ -85775,6 +86765,11 @@ export type SchemaNullableMinimalRepository = components['schemas']['nullable-mi export type SchemaPackage = components['schemas']['package']; export type SchemaOrganizationInvitation = components['schemas']['organization-invitation']; export type SchemaOrgHook = components['schemas']['org-hook']; +export type SchemaApiInsightsRouteStats = components['schemas']['api-insights-route-stats']; +export type SchemaApiInsightsSubjectStats = components['schemas']['api-insights-subject-stats']; +export type SchemaApiInsightsSummaryStats = components['schemas']['api-insights-summary-stats']; +export type SchemaApiInsightsTimeStats = components['schemas']['api-insights-time-stats']; +export type SchemaApiInsightsUserStats = components['schemas']['api-insights-user-stats']; export type SchemaInteractionGroup = components['schemas']['interaction-group']; export type SchemaInteractionLimitResponse = components['schemas']['interaction-limit-response']; export type SchemaInteractionExpiry = components['schemas']['interaction-expiry']; @@ -85810,6 +86805,7 @@ export type SchemaRepositoryRuleRequiredLinearHistory = components['schemas']['r export type SchemaRepositoryRuleMergeQueue = components['schemas']['repository-rule-merge-queue']; export type SchemaRepositoryRuleRequiredDeployments = components['schemas']['repository-rule-required-deployments']; export type SchemaRepositoryRuleRequiredSignatures = components['schemas']['repository-rule-required-signatures']; +export type SchemaRepositoryRuleParamsRequiredReviewerConfiguration = components['schemas']['repository-rule-params-required-reviewer-configuration']; export type SchemaRepositoryRulePullRequest = components['schemas']['repository-rule-pull-request']; export type SchemaRepositoryRuleParamsStatusCheckConfiguration = components['schemas']['repository-rule-params-status-check-configuration']; export type SchemaRepositoryRuleRequiredStatusChecks = components['schemas']['repository-rule-required-status-checks']; @@ -86096,7 +87092,6 @@ export type SchemaEnterpriseWebhooks = components['schemas']['enterprise-webhook export type SchemaSimpleInstallation = components['schemas']['simple-installation']; export type SchemaOrganizationSimpleWebhooks = components['schemas']['organization-simple-webhooks']; export type SchemaRepositoryWebhooks = components['schemas']['repository-webhooks']; -export type SchemaSimpleUserWebhooks = components['schemas']['simple-user-webhooks']; export type SchemaWebhooksRule = components['schemas']['webhooks_rule']; export type SchemaSimpleCheckSuite = components['schemas']['simple-check-suite']; export type SchemaCheckRunWithSimpleCheckSuite = components['schemas']['check-run-with-simple-check-suite']; @@ -86379,6 +87374,7 @@ export type SchemaWebhookRepositoryVulnerabilityAlertResolve = components['schem export type SchemaWebhookSecretScanningAlertCreated = components['schemas']['webhook-secret-scanning-alert-created']; export type SchemaWebhookSecretScanningAlertLocationCreated = components['schemas']['webhook-secret-scanning-alert-location-created']; export type SchemaWebhookSecretScanningAlertLocationCreatedFormEncoded = components['schemas']['webhook-secret-scanning-alert-location-created-form-encoded']; +export type SchemaWebhookSecretScanningAlertPubliclyLeaked = components['schemas']['webhook-secret-scanning-alert-publicly-leaked']; export type SchemaWebhookSecretScanningAlertReopened = components['schemas']['webhook-secret-scanning-alert-reopened']; export type SchemaWebhookSecretScanningAlertResolved = components['schemas']['webhook-secret-scanning-alert-resolved']; export type SchemaWebhookSecretScanningAlertValidated = components['schemas']['webhook-secret-scanning-alert-validated']; @@ -86423,6 +87419,7 @@ export type ResponseNotModified = components['responses']['not_modified']; export type ResponseRequiresAuthentication = components['responses']['requires_authentication']; export type ResponseForbidden = components['responses']['forbidden']; export type ResponseInternalError = components['responses']['internal_error']; +export type ResponseUsageMetricsApiDisabled = components['responses']['usage_metrics_api_disabled']; export type ResponseServiceUnavailable = components['responses']['service_unavailable']; export type ResponseForbiddenGist = components['responses']['forbidden_gist']; export type ResponseMovedPermanently = components['responses']['moved_permanently']; @@ -86469,6 +87466,9 @@ export type ParameterSecretScanningAlertSecretType = components['parameters']['s export type ParameterSecretScanningAlertResolution = components['parameters']['secret-scanning-alert-resolution']; export type ParameterSecretScanningAlertSort = components['parameters']['secret-scanning-alert-sort']; export type ParameterSecretScanningAlertValidity = components['parameters']['secret-scanning-alert-validity']; +export type ParameterSecretScanningAlertPubliclyLeaked = components['parameters']['secret-scanning-alert-publicly-leaked']; +export type ParameterSecretScanningAlertMultiRepo = components['parameters']['secret-scanning-alert-multi-repo']; +export type ParameterEnterpriseTeamSlug = components['parameters']['enterprise-team-slug']; export type ParameterTeamSlug = components['parameters']['team-slug']; export type ParameterGistId = components['parameters']['gist-id']; export type ParameterCommentId = components['parameters']['comment-id']; @@ -86485,6 +87485,8 @@ export type ParameterThreadId = components['parameters']['thread-id']; export type ParameterSinceOrg = components['parameters']['since-org']; export type ParameterOrg = components['parameters']['org']; export type ParameterRepositoryId = components['parameters']['repository-id']; +export type ParameterVisibleToRepository = components['parameters']['visible-to-repository']; +export type ParameterRunnerGroupId = components['parameters']['runner-group-id']; export type ParameterRunnerId = components['parameters']['runner-id']; export type ParameterRunnerLabelName = components['parameters']['runner-label-name']; export type ParameterSecretName = components['parameters']['secret-name']; @@ -86495,6 +87497,14 @@ export type ParameterToolName = components['parameters']['tool-name']; export type ParameterToolGuid = components['parameters']['tool-guid']; export type ParameterConfigurationId = components['parameters']['configuration-id']; export type ParameterHookId = components['parameters']['hook-id']; +export type ParameterApiInsightsActorType = components['parameters']['api-insights-actor-type']; +export type ParameterApiInsightsActorId = components['parameters']['api-insights-actor-id']; +export type ParameterApiInsightsMinTimestamp = components['parameters']['api-insights-min-timestamp']; +export type ParameterApiInsightsMaxTimestamp = components['parameters']['api-insights-max-timestamp']; +export type ParameterApiInsightsRouteStatsSort = components['parameters']['api-insights-route-stats-sort']; +export type ParameterApiInsightsSort = components['parameters']['api-insights-sort']; +export type ParameterApiInsightsUserId = components['parameters']['api-insights-user-id']; +export type ParameterApiInsightsTimestampIncrement = components['parameters']['api-insights-timestamp-increment']; export type ParameterInvitationId = components['parameters']['invitation-id']; export type ParameterCodespaceName = components['parameters']['codespace-name']; export type ParameterMigrationId = components['parameters']['migration-id']; @@ -86512,6 +87522,7 @@ export type ParameterPersonalAccessTokenBefore = components['parameters']['perso export type ParameterPersonalAccessTokenAfter = components['parameters']['personal-access-token-after']; export type ParameterFineGrainedPersonalAccessTokenId = components['parameters']['fine-grained-personal-access-token-id']; export type ParameterCustomPropertyName = components['parameters']['custom-property-name']; +export type ParameterRulesetTargets = components['parameters']['ruleset-targets']; export type ParameterRefInQuery = components['parameters']['ref-in-query']; export type ParameterRepositoryNameInQuery = components['parameters']['repository-name-in-query']; export type ParameterTimePeriod = components['parameters']['time-period']; @@ -86554,6 +87565,7 @@ export type ParameterCheckSuiteId = components['parameters']['check-suite-id']; export type ParameterCheckName = components['parameters']['check-name']; export type ParameterStatus = components['parameters']['status']; export type ParameterGitRef = components['parameters']['git-ref']; +export type ParameterPrAlias = components['parameters']['pr-alias']; export type ParameterAlertNumber = components['parameters']['alert-number']; export type ParameterCommitSha = components['parameters']['commit-sha']; export type ParameterCommitRef = components['parameters']['commit-ref']; @@ -86826,7 +87838,6 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; header?: never; path?: never; @@ -87301,7 +88312,7 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "classroom/list-accepted-assigments-for-an-assignment": { + "classroom/list-accepted-assignments-for-an-assignment": { parameters: { query?: { /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -87535,6 +88546,42 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "copilot/copilot-metrics-for-enterprise": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-enterprise": { parameters: { query?: { @@ -87658,6 +88705,10 @@ export interface operations { after?: components["parameters"]["pagination-after"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; header?: never; path: { @@ -87682,6 +88733,44 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "copilot/copilot-metrics-for-enterprise-team": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the enterprise team name. */ + team_slug: components["parameters"]["enterprise-team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-enterprise-team": { parameters: { query?: { @@ -89263,7 +90352,7 @@ export interface operations { members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -89296,7 +90385,7 @@ export interface operations { blog?: string; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. * @@ -89307,7 +90396,7 @@ export interface operations { advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * @@ -89318,7 +90407,7 @@ export interface operations { dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * @@ -89329,7 +90418,7 @@ export interface operations { dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * @@ -89340,7 +90429,7 @@ export interface operations { dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * @@ -89351,7 +90440,7 @@ export interface operations { secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * @@ -89364,6 +90453,8 @@ export interface operations { secret_scanning_push_protection_custom_link_enabled?: boolean; /** @description If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. */ secret_scanning_push_protection_custom_link?: string; + /** @description Controls whether or not deploy keys may be added and used for repositories in the organization. */ + deploy_keys_enabled_for_repositories?: boolean; }; }; }; @@ -89749,6 +90840,415 @@ export interface operations { }; }; }; + "actions/list-self-hosted-runner-groups-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description Only return runner groups that are allowed to be used by this repository. */ + visible_to_repository?: components["parameters"]["visible-to-repository"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runner_groups: components["schemas"]["runner-groups-org"][]; + }; + }; + }; + }; + }; + "actions/create-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner group. */ + name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. + * @default all + * @enum {string} + */ + visibility?: "selected" | "all" | "private"; + /** @description List of repository IDs that can access the runner group. */ + selected_repository_ids?: number[]; + /** @description List of runner IDs to add to the runner group. */ + runners?: number[]; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + allows_public_repositories?: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + restricted_to_workflows?: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + selected_workflows?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + "actions/get-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + "actions/delete-self-hosted-runner-group-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/update-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner group. */ + name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. + * @enum {string} + */ + visibility?: "selected" | "all" | "private"; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + allows_public_repositories?: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + restricted_to_workflows?: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + selected_workflows?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + "actions/list-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + }; + "actions/set-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of repository IDs that can access the runner group. */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/add-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/list-self-hosted-runners-in-group-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; + }; + }; + }; + }; + }; + "actions/set-self-hosted-runners-in-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of runner IDs to add to the runner group. */ + runners: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/add-self-hosted-runner-to-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/remove-self-hosted-runner-from-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "actions/list-self-hosted-runners-for-org": { parameters: { query?: { @@ -90923,6 +92423,25 @@ export interface operations { * @enum {string} */ secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @default disabled @@ -91127,6 +92646,24 @@ export interface operations { * @enum {string} */ secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @enum {string} @@ -91188,7 +92725,7 @@ export interface operations { * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` * @enum {string} */ - scope: "all" | "public" | "private_or_internal" | "selected"; + scope: "all" | "all_without_configurations" | "public" | "private_or_internal" | "selected"; /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ selected_repository_ids?: number[]; }; @@ -91974,6 +93511,42 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "copilot/copilot-metrics-for-organization": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-org": { parameters: { query?: { @@ -92571,45 +94144,286 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "orgs/update-webhook": { + "orgs/update-webhook": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Key/value pairs to provide settings for this webhook. */ + config?: { + url: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + /** + * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. + * @default [ + * "push" + * ] + */ + events?: string[]; + /** + * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + * @default true + */ + active?: boolean; + /** @example "web" */ + name?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-hook"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/get-webhook-config-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + }; + "orgs/update-webhook-config-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + url?: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + }; + "orgs/list-webhook-deliveries": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ + cursor?: components["parameters"]["cursor"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["hook-delivery-item"][]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/get-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["hook-delivery"]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/redeliver-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/ping-webhook": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "api-insights/get-route-stats-by-actor": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: components["parameters"]["api-insights-route-stats-sort"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; + /** @description The type of the actor */ + actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + actor_id: components["parameters"]["api-insights-actor-id"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** @description Key/value pairs to provide settings for this webhook. */ - config?: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - /** - * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. - * @default [ - * "push" - * ] - */ - events?: string[]; - /** - * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - * @default true - */ - active?: boolean; - /** @example "web" */ - name?: string; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["api-insights-route-stats"]; }; }; }; + }; + "api-insights/get-subject-stats": { + parameters: { + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: components["parameters"]["api-insights-sort"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -92617,22 +94431,23 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-hook"]; + "application/json": components["schemas"]["api-insights-subject-stats"]; }; }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/get-webhook-config-for-org": { + "api-insights/get-summary-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; }; cookie?: never; }; @@ -92644,33 +94459,61 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - "orgs/update-webhook-config-for-org": { + "api-insights/get-summary-stats-by-user": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; + /** @description The ID of the user to query for stats */ + user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; + }; + "api-insights/get-summary-stats-by-actor": { + parameters: { + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The type of the actor */ + actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + actor_id: components["parameters"]["api-insights-actor-id"]; + }; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -92678,26 +94521,25 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - "orgs/list-webhook-deliveries": { + "api-insights/get-time-stats": { parameters: { - query?: { - /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: components["parameters"]["per-page"]; - /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; }; cookie?: never; }; @@ -92709,23 +94551,27 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["hook-delivery-item"][]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/get-webhook-delivery": { + "api-insights/get-time-stats-by-user": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; + /** @description The ID of the user to query for stats */ + user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; @@ -92737,55 +94583,81 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["hook-delivery"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/redeliver-webhook-delivery": { + "api-insights/get-time-stats-by-actor": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; + /** @description The type of the actor */ + actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + actor_id: components["parameters"]["api-insights-actor-id"]; }; cookie?: never; }; requestBody?: never; responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; }; }; - "orgs/ping-webhook": { + "api-insights/get-user-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: components["parameters"]["api-insights-sort"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; + /** @description The ID of the user to query for stats */ + user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["api-insights-user-stats"]; + }; }; - 404: components["responses"]["not_found"]; }; }; "apps/get-org-installation": { @@ -94766,7 +96638,7 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; @@ -94793,7 +96665,7 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; @@ -94840,7 +96712,7 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; @@ -95152,7 +97024,7 @@ export interface operations { delete_branch_on_merge?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -95224,6 +97096,11 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + targets?: components["parameters"]["ruleset-targets"]; }; header?: never; path: { @@ -95487,6 +97364,10 @@ export interface operations { after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; header?: never; path: { @@ -95687,6 +97568,44 @@ export interface operations { }; }; }; + "copilot/copilot-metrics-for-team": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-team": { parameters: { query?: { @@ -95797,7 +97716,7 @@ export interface operations { */ notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -95907,7 +97826,7 @@ export interface operations { */ notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -97918,6 +99837,11 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." */ + secret_scanning_ai_detection?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_scanning_non_provider_patterns?: { /** @description Can be `enabled` or `disabled`. */ @@ -97978,7 +99902,7 @@ export interface operations { allow_update_branch?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -100760,7 +102684,7 @@ export interface operations { strict: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -101229,7 +103153,7 @@ export interface operations { strict?: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -101488,12 +103412,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ apps: string[]; - } | string[]; + }; }; }; responses: { @@ -101523,12 +103447,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ apps: string[]; - } | string[]; + }; }; }; responses: { @@ -101558,12 +103482,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ apps: string[]; - } | string[]; + }; }; }; responses: { @@ -101754,12 +103678,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ users: string[]; - } | string[]; + }; }; }; responses: { @@ -101789,12 +103713,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ users: string[]; - } | string[]; + }; }; }; responses: { @@ -101824,12 +103748,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ users: string[]; - } | string[]; + }; }; }; responses: { @@ -102419,8 +104343,14 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["git-ref"]; + /** @description The number of the pull request for the results you want to list. */ + pr?: components["parameters"]["pr-alias"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; /** @description The property by which to sort the results. */ sort?: "created" | "updated"; /** @description If specified, only code scanning alerts with this state will be returned. */ @@ -102532,6 +104462,8 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["git-ref"]; + /** @description The number of the pull request for the results you want to list. */ + pr?: components["parameters"]["pr-alias"]; }; header?: never; path: { @@ -102571,6 +104503,8 @@ export interface operations { page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The number of the pull request for the results you want to list. */ + pr?: components["parameters"]["pr-alias"]; /** @description The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ @@ -102731,6 +104665,34 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "code-scanning/delete-codeql-database": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The language of the CodeQL database. */ + language: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "code-scanning/create-variant-analysis": { parameters: { query?: never; @@ -103137,7 +105099,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -104030,7 +105992,7 @@ export interface operations { path?: string; /** @description Line index in the diff to comment on. */ position?: number; - /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ + /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ line?: number; }; }; @@ -104575,7 +106537,7 @@ export interface operations { direction?: components["parameters"]["direction"]; /** * @deprecated - * @description **Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. + * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. */ page?: number; /** @@ -105286,7 +107248,7 @@ export interface operations { "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ event_type: string; - /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ + /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. */ client_payload?: { [key: string]: unknown; }; @@ -107011,7 +108973,6 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; header?: never; path: { @@ -107701,7 +109662,7 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ + /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ assignee?: string | null; milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ @@ -108086,7 +110047,7 @@ export interface operations { title?: (string | number) | null; /** @description The contents of the issue. */ body?: string | null; - /** @description Username to assign to this issue. **This field is deprecated.** */ + /** @description Username to assign to this issue. **This field is closing down.** */ assignee?: string | null; /** * @description The open or closed state of the issue. @@ -110530,7 +112491,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -110642,7 +112603,7 @@ export interface operations { path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * @description **This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ position?: number; /** @@ -112057,6 +114018,11 @@ export interface operations { page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + targets?: components["parameters"]["ruleset-targets"]; }; header?: never; path: { @@ -112335,6 +114301,10 @@ export interface operations { after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; header?: never; path: { @@ -113697,12 +115667,12 @@ export interface operations { q: string; /** * @deprecated - * @description **This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) + * @description **This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "indexed"; /** * @deprecated - * @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + * @description **This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -114041,7 +116011,7 @@ export interface operations { */ notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -115333,7 +117303,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -115364,7 +117334,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -116193,6 +118163,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; "users/unfollow": { diff --git a/packages/openapi-typescript/examples/github-api.ts b/packages/openapi-typescript/examples/github-api.ts index 9f2016e9e..9906eb7f0 100644 --- a/packages/openapi-typescript/examples/github-api.ts +++ b/packages/openapi-typescript/examples/github-api.ts @@ -453,7 +453,7 @@ export interface paths { * List accepted assignments for an assignment * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ - get: operations["classroom/list-accepted-assigments-for-an-assignment"]; + get: operations["classroom/list-accepted-assignments-for-an-assignment"]; put?: never; post?: never; delete?: never; @@ -612,13 +612,16 @@ export interface paths { /** * List all Copilot seat assignments for an enterprise * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + * Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. * * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. * * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + * telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + * see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. * @@ -633,6 +636,35 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for an enterprise + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/enterprises/{enterprise}/copilot/usage": { parameters: { query?: never; @@ -643,7 +675,7 @@ export interface paths { /** * Get a summary of Copilot usage for enterprise members * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -653,6 +685,8 @@ export interface paths { * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * + * The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + * * Only owners and billing managers can view Copilot usage metrics for the enterprise. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -718,6 +752,38 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for an enterprise team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-enterprise-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { parameters: { query?: never; @@ -728,7 +794,7 @@ export interface paths { /** * Get a summary of Copilot usage for an enterprise team * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -1609,10 +1675,10 @@ export interface paths { /** * Update an organization * @description > [!WARNING] - * > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * > **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * > [!WARNING] - * > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * * Updates the organization's profile and member privileges. * @@ -1842,6 +1908,180 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List self-hosted runner groups for an organization + * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-self-hosted-runner-groups-for-org"]; + put?: never; + /** + * Create a self-hosted runner group for an organization + * @description Creates a new self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["actions/create-self-hosted-runner-group-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a self-hosted runner group for an organization + * @description Gets a specific self-hosted runner group for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/get-self-hosted-runner-group-for-org"]; + put?: never; + post?: never; + /** + * Delete a self-hosted runner group from an organization + * @description Deletes a self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + options?: never; + head?: never; + /** + * Update a self-hosted runner group for an organization + * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + patch: operations["actions/update-self-hosted-runner-group-for-org"]; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List repository access to a self-hosted runner group in an organization + * @description Lists the repositories with access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; + /** + * Set repository access for a self-hosted runner group in an organization + * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Add repository access to a self-hosted runner group in an organization + * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; + /** + * Remove repository access to a self-hosted runner group in an organization + * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List self-hosted runners in a group for an organization + * @description Lists self-hosted runners that are in a specific organization group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-self-hosted-runners-in-group-for-org"]; + /** + * Set self-hosted runners in a group for an organization + * @description Replaces the list of self-hosted runners that are part of an organization runner group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Add a self-hosted runner to a group for an organization + * @description Adds a self-hosted runner to a runner group configured in an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + post?: never; + /** + * Remove a self-hosted runner from a group for an organization + * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/runners": { parameters: { query?: never; @@ -2912,11 +3152,11 @@ export interface paths { /** * Get Copilot seat information and settings for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Gets information about an organization's Copilot subscription, including seat breakdown * and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." * * Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. * @@ -2941,11 +3181,14 @@ export interface paths { /** * List all Copilot seat assignments for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + * Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. * Only organization owners can view assigned seats. * + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/list-copilot-seats"]; @@ -2969,16 +3212,16 @@ export interface paths { /** * Add teams to the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * * Only organization owners can add Copilot seats for their organization members. * * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * * The response will contain the total number of new seats that were created and existing seats that were refreshed. * @@ -2988,17 +3231,19 @@ export interface paths { /** * Remove teams from the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Cancels the Copilot seat assignment for all members of each team specified. - * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Sets seats for all members of each team specified to "pending cancellation". + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * + * The response will contain the total number of seats set to "pending cancellation". + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; @@ -3019,16 +3264,16 @@ export interface paths { /** * Add users to the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * * Only organization owners can add Copilot seats for their organization members. * * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * * The response will contain the total number of new seats that were created and existing seats that were refreshed. * @@ -3038,17 +3283,19 @@ export interface paths { /** * Remove users from the Copilot subscription for an organization * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Cancels the Copilot seat assignment for each user specified. - * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Sets seats for all users specified to "pending cancellation". + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * + * The response will contain the total number of seats set to "pending cancellation". + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; @@ -3057,6 +3304,38 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for an organization + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + * Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/copilot/usage": { parameters: { query?: never; @@ -3067,7 +3346,7 @@ export interface paths { /** * Get a summary of Copilot usage for organization members * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -3534,6 +3813,186 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get route stats by actor + * @description Get API request count statistics for an actor broken down by route within a specified time frame. + */ + get: operations["api-insights/get-route-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/subject-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get subject stats + * @description Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + */ + get: operations["api-insights/get-subject-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/summary-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get summary stats + * @description Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + */ + get: operations["api-insights/get-summary-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get summary stats by user + * @description Get overall statistics of API requests within the organization for a user. + */ + get: operations["api-insights/get-summary-stats-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get summary stats by actor + * @description Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + */ + get: operations["api-insights/get-summary-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/time-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get time stats + * @description Get the number of API requests and rate-limited requests made within an organization over a specified time period. + */ + get: operations["api-insights/get-time-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/time-stats/users/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get time stats by user + * @description Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + */ + get: operations["api-insights/get-time-stats-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get time stats by actor + * @description Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + */ + get: operations["api-insights/get-time-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/insights/api/user-stats/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get user stats + * @description Get API usage statistics within an organization for a user broken down by the type of access. + */ + get: operations["api-insights/get-user-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/installation": { parameters: { query?: never; @@ -3831,9 +4290,12 @@ export interface paths { /** * Get Copilot seat assignment details for a user * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * - * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + * + * The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * * Only organization owners can view Copilot seat assignment details for members of their organization. * @@ -4272,7 +4734,7 @@ export interface paths { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; put?: never; @@ -4294,7 +4756,7 @@ export interface paths { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; put?: never; @@ -4305,7 +4767,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; options?: never; @@ -4332,7 +4794,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; delete?: never; @@ -4352,7 +4814,7 @@ export interface paths { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; put?: never; @@ -4374,7 +4836,7 @@ export interface paths { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; put?: never; @@ -4385,7 +4847,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; options?: never; @@ -4412,7 +4874,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; delete?: never; @@ -5041,6 +5503,38 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Copilot metrics for a team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + * Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/team/{team_slug}/copilot/usage": { parameters: { query?: never; @@ -5051,7 +5545,7 @@ export interface paths { /** * Get a summary of Copilot usage for a team * @description > [!NOTE] - * > This endpoint is in beta and is subject to change. + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -5689,7 +6183,7 @@ export interface paths { * Enable or disable a security feature for an organization * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). * * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -5949,7 +6443,7 @@ export interface paths { * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." * * > [!NOTE] - * > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; put?: never; @@ -8355,7 +8849,7 @@ export interface paths { * and `0` is returned in this field. * * > [!WARNING] - * > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -8482,7 +8976,7 @@ export interface paths { * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-codeql-databases"]; put?: never; @@ -8510,12 +9004,18 @@ export interface paths { * your HTTP client is configured to follow redirects or use the `Location` header * to make a second request to get the redirect URL. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-codeql-database"]; put?: never; post?: never; - delete?: never; + /** + * Delete a CodeQL database + * @description Deletes a CodeQL database for a language in a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + delete: operations["code-scanning/delete-codeql-database"]; options?: never; head?: never; patch?: never; @@ -8894,8 +9394,6 @@ export interface paths { * @description Gets your public key, which you need to encrypt secrets. You need to * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. - * * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/get-repo-public-key"]; @@ -11038,7 +11536,7 @@ export interface paths { * @description View the progress of an import. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -11082,7 +11580,7 @@ export interface paths { * return a status `422 Unprocessable Entity` response. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ put: operations["migrations/start-import"]; post?: never; @@ -11092,7 +11590,7 @@ export interface paths { * @description Stop an import for a repository. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ delete: operations["migrations/cancel-import"]; options?: never; @@ -11108,7 +11606,7 @@ export interface paths { * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/update-import"]; trace?: never; @@ -11128,7 +11626,7 @@ export interface paths { * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-commit-authors"]; put?: never; @@ -11159,7 +11657,7 @@ export interface paths { * new commits to the repository. * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/map-commit-author"]; trace?: never; @@ -11177,7 +11675,7 @@ export interface paths { * @description List files larger than 100MB found during the import * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-large-files"]; put?: never; @@ -11211,7 +11709,7 @@ export interface paths { * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * * > [!WARNING] - * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/set-lfs-preference"]; trace?: never; @@ -11540,7 +12038,7 @@ export interface paths { head?: never; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12638,7 +13136,7 @@ export interface paths { * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." @@ -12991,6 +13489,7 @@ export interface paths { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ put: operations["pulls/update-branch"]; post?: never; @@ -13885,10 +14384,10 @@ export interface paths { cookie?: never; }; /** - * Deprecated - List tag protection states for a repository + * Closing down - List tag protection states for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. * * This returns the tag protection states of a repository. * @@ -13897,10 +14396,10 @@ export interface paths { get: operations["repos/list-tag-protection"]; put?: never; /** - * Deprecated - Create a tag protection state for a repository + * Closing down - Create a tag protection state for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. * * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13923,10 +14422,10 @@ export interface paths { put?: never; post?: never; /** - * Deprecated - Delete a tag protection state for a repository + * Closing down - Delete a tag protection state for a repository * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. * * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -14428,7 +14927,7 @@ export interface paths { * Get a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; put?: never; @@ -14437,7 +14936,7 @@ export interface paths { * Delete a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -14450,7 +14949,7 @@ export interface paths { * Update a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * @@ -14471,7 +14970,7 @@ export interface paths { * List discussions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -14483,7 +14982,7 @@ export interface paths { * Create a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * @@ -14509,7 +15008,7 @@ export interface paths { * Get a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -14522,7 +15021,7 @@ export interface paths { * Delete a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -14535,7 +15034,7 @@ export interface paths { * Update a discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -14555,7 +15054,7 @@ export interface paths { * List discussion comments (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -14567,7 +15066,7 @@ export interface paths { * Create a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * @@ -14593,7 +15092,7 @@ export interface paths { * Get a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -14606,7 +15105,7 @@ export interface paths { * Delete a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -14619,7 +15118,7 @@ export interface paths { * Update a discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -14639,7 +15138,7 @@ export interface paths { * List reactions for a team discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14651,7 +15150,7 @@ export interface paths { * Create reaction for a team discussion comment (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14677,7 +15176,7 @@ export interface paths { * List reactions for a team discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14689,7 +15188,7 @@ export interface paths { * Create reaction for a team discussion (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14715,7 +15214,7 @@ export interface paths { * List pending team invitations (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ @@ -14739,7 +15238,7 @@ export interface paths { * List team members (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -14762,7 +15261,7 @@ export interface paths { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * @@ -14772,7 +15271,7 @@ export interface paths { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * @@ -14790,7 +15289,7 @@ export interface paths { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * @@ -14818,7 +15317,7 @@ export interface paths { * Get team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -14834,7 +15333,7 @@ export interface paths { * Add or update team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -14853,7 +15352,7 @@ export interface paths { * Remove team membership for a user (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -14879,7 +15378,7 @@ export interface paths { * List team projects (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -14903,7 +15402,7 @@ export interface paths { * Check team permissions for a project (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -14912,7 +15411,7 @@ export interface paths { * Add or update team project permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -14922,7 +15421,7 @@ export interface paths { * Remove a project from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -14943,7 +15442,7 @@ export interface paths { * List team repositories (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; put?: never; @@ -14965,7 +15464,7 @@ export interface paths { * Check team permissions for a repository (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * * > [!NOTE] * > Repositories inherited through a parent team will also be checked. @@ -14977,7 +15476,7 @@ export interface paths { * Add or update team repository permissions (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -14989,7 +15488,7 @@ export interface paths { * Remove a repository from a team (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -15010,7 +15509,7 @@ export interface paths { * List child teams (Legacy) * @deprecated * @description > [!WARNING] - * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; put?: never; @@ -16068,6 +16567,9 @@ export interface paths { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ get: operations["orgs/list-for-authenticated-user"]; put?: never; @@ -16089,7 +16591,7 @@ export interface paths { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; put?: never; @@ -16111,7 +16613,7 @@ export interface paths { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; put?: never; @@ -16120,7 +16622,7 @@ export interface paths { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; options?: never; @@ -16145,7 +16647,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; delete?: never; @@ -16165,7 +16667,7 @@ export interface paths { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; put?: never; @@ -16187,7 +16689,7 @@ export interface paths { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; put?: never; @@ -16198,7 +16700,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; options?: never; @@ -16223,7 +16725,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; delete?: never; @@ -16652,7 +17154,7 @@ export interface paths { }; /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). * * > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. @@ -16906,7 +17408,7 @@ export interface paths { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; put?: never; @@ -16928,7 +17430,7 @@ export interface paths { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; put?: never; @@ -16939,7 +17441,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; options?: never; @@ -16966,7 +17468,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; delete?: never; @@ -16986,7 +17488,7 @@ export interface paths { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; put?: never; @@ -17008,7 +17510,7 @@ export interface paths { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; put?: never; @@ -17019,7 +17521,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; options?: never; @@ -17046,7 +17548,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; delete?: never; @@ -17516,6 +18018,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; }; /** * @description The type of credit the user is receiving. @@ -17710,6 +18214,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; } | null; /** * GitHub app @@ -18227,7 +18733,7 @@ export interface components { */ organization_custom_properties?: "read" | "write" | "admin"; /** - * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. * @enum {string} */ organization_copilot_seat_management?: "write"; @@ -18262,7 +18768,7 @@ export interface components { */ organization_plan?: "read"; /** - * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). + * @description The level of permission to grant the access token to manage organization projects and projects public preview (where available). * @enum {string} */ organization_projects?: "read" | "write" | "admin"; @@ -18706,7 +19212,7 @@ export interface components { allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -19290,7 +19796,7 @@ export interface components { * Organization Simple * @description A GitHub organization. */ - "organization-simple": { + "nullable-organization-simple": { /** @example github */ login: string; /** @example 1 */ @@ -19324,7 +19830,7 @@ export interface components { avatar_url: string; /** @example A great organization */ description: string | null; - }; + } | null; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -19433,8 +19939,8 @@ export interface components { url: string; /** @example disabled | all */ sync_to_organizations: string; - /** @example 1 */ - group_id?: number | null; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id?: string | null; /** * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league @@ -19451,12 +19957,8 @@ export interface components { * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ "copilot-seat-details": { - /** @description The assignee that has been granted access to GitHub Copilot. */ - assignee: { - [key: string]: unknown; - } & components["schemas"]["simple-user"]; - /** @description The organization to which this seat belongs. */ - organization?: components["schemas"]["organization-simple"] | null; + assignee: components["schemas"]["simple-user"]; + organization?: components["schemas"]["nullable-organization-simple"]; /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; /** @@ -19481,6 +19983,157 @@ export interface components { * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. */ updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + "copilot-ide-code-completions": ({ + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + }[]; + editors?: ({ + /** @description Name of the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages, for the given editor. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + total_code_suggestions?: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + total_code_acceptances?: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + total_code_lines_suggested?: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + total_code_lines_accepted?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + })[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + "copilot-ide-chat": ({ + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + total_engaged_users?: number; + editors?: { + /** @description Name of the given editor. */ + name?: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + total_engaged_users?: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + total_chats?: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + total_chat_insertion_events?: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + total_chat_copy_events?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in github.com */ + "copilot-dotcom-chat": ({ + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + total_engaged_users?: number; + /** @description List of model metrics for a custom models and the default model. */ + models?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model (if applicable). */ + custom_model_training_date?: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + total_engaged_users?: number; + /** @description Total number of chats initiated by users on github.com. */ + total_chats?: number; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot for pull requests. */ + "copilot-dotcom-pull-requests": ({ + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + total_engaged_users?: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + repositories?: { + /** @description Repository name */ + name?: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + total_pr_summaries_created?: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + total_engaged_users?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_engaged_users?: number; + copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + } & { + [key: string]: unknown; }; /** * Copilot Usage Metrics @@ -19991,6 +20644,10 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; + /** @description Whether the secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + multi_repo?: boolean | null; }; /** * Actor @@ -20438,6 +21095,11 @@ export interface components { language?: string; raw_url?: string; size?: number; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding: string; }; }; public: boolean; @@ -20463,6 +21125,11 @@ export interface components { login: string; /** Format: int64 */ id: number; + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + user_view_type: "public"; node_id: string; /** Format: uri */ avatar_url: string; @@ -20512,8 +21179,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; /** @example 1 */ private_gists?: number; /** @example 2 */ @@ -20620,6 +21285,11 @@ export interface components { size?: number; truncated?: boolean; content?: string; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding: string; } | null; }; public?: boolean; @@ -20988,6 +21658,10 @@ export interface components { /** @enum {string} */ status?: "enabled" | "disabled"; }; + secret_scanning_ai_detection?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; } | null; /** * Minimal Repository @@ -21254,6 +21928,45 @@ export interface components { */ repository_url?: string; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + avatar_url: string; + /** @example A great organization */ + description: string | null; + }; /** * Organization Full * @description Organization Full @@ -21339,7 +22052,12 @@ export interface components { private_gists?: number | null; /** @example 10000 */ disk_usage?: number | null; - /** @example 8 */ + /** + * @description The number of collaborators on private repositories. + * + * This field may be null if the number of private repositories is over 50,000. + * @example 8 + */ collaborators?: number | null; /** * Format: email @@ -21378,7 +22096,7 @@ export interface components { web_commit_signoff_required?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * @@ -21388,7 +22106,7 @@ export interface components { advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * @@ -21398,7 +22116,7 @@ export interface components { dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * @@ -21408,7 +22126,7 @@ export interface components { dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * @@ -21418,7 +22136,7 @@ export interface components { dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * @@ -21428,7 +22146,7 @@ export interface components { secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * @@ -21455,6 +22173,11 @@ export interface components { updated_at: string; /** Format: date-time */ archived_at: string | null; + /** + * @description Controls whether or not deploy keys may be added and used for repositories in the organization. + * @example false + */ + deploy_keys_enabled_for_repositories?: boolean; }; "actions-cache-usage-org-enterprise": { /** @description The count of active caches across all repositories of an enterprise or an organization. */ @@ -21541,6 +22264,31 @@ export interface components { default_workflow_permissions?: components["schemas"]["actions-default-workflow-permissions"]; can_approve_pull_request_reviews?: components["schemas"]["actions-can-approve-pull-request-reviews"]; }; + "runner-groups-org": { + id: number; + name: string; + visibility: string; + default: boolean; + /** @description Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ + selected_repositories_url?: string; + runners_url: string; + hosted_runners_url?: string; + inherited: boolean; + inherited_allows_public_repositories?: boolean; + allows_public_repositories: boolean; + /** + * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. + * @default false + */ + workflow_restrictions_read_only: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + restricted_to_workflows: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + selected_workflows?: string[]; + }; /** * Self hosted runner label * @description A label for a self hosted runner @@ -21741,9 +22489,9 @@ export interface components { "alert-instances-url": string; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} @@ -21850,7 +22598,7 @@ export interface components { * @description The type of the code security configuration. * @enum {string} */ - target_type?: "global" | "organization"; + target_type?: "global" | "organization" | "enterprise"; /** @description A description of the code security configuration */ description?: string; /** @@ -21898,6 +22646,24 @@ export interface components { * @enum {string} */ secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @enum {string} @@ -22225,8 +22991,8 @@ export interface components { inactive_this_cycle?: number; }; /** - * Copilot Business Organization Details - * @description Information about the seat breakdown and policies set for an organization with a Copilot Business subscription. + * Copilot Organization Details + * @description Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription. */ "copilot-organization-details": { seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; @@ -22255,6 +23021,11 @@ export interface components { * @enum {string} */ seat_management_setting: "assign_all" | "assign_selected" | "disabled" | "unconfigured"; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; } & { [key: string]: unknown; }; @@ -22629,6 +23400,87 @@ export interface components { created_at: string; type: string; }; + /** + * Route Stats + * @description API Insights usage route stats for an actor + */ + "api-insights-route-stats": { + /** @description The HTTP method */ + http_method?: string; + /** @description The API path's route template */ + api_route?: string; + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; + /** + * Subject Stats + * @description API Insights usage subject stats for an organization + */ + "api-insights-subject-stats": { + subject_type?: string; + subject_name?: string; + /** Format: int64 */ + subject_id?: number; + total_request_count?: number; + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; + /** + * Summary Stats + * @description API Insights usage summary stats for an organization + */ + "api-insights-summary-stats": { + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count?: number; + }; + /** + * Time Stats + * @description API Insights usage time stats for an organization + */ + "api-insights-time-stats": { + timestamp?: string; + /** Format: int64 */ + total_request_count?: number; + /** Format: int64 */ + rate_limited_request_count?: number; + }[]; + /** + * User Stats + * @description API Insights usage stats for a user + */ + "api-insights-user-stats": { + actor_type?: string; + actor_name?: string; + /** Format: int64 */ + actor_id?: number; + /** Format: int64 */ + integration_id?: number | null; + /** Format: int64 */ + oauth_application_id?: number | null; + total_request_count?: number; + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; /** * @description The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. * @example collaborators_only @@ -22933,6 +23785,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; }; /** * Package Version @@ -23021,6 +23875,10 @@ export interface components { }; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -23033,7 +23891,7 @@ export interface components { * @description Minimal representation of an organization programmatic access grant for enumerations */ "organization-programmatic-access-grant": { - /** @description Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token. */ + /** @description Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. */ id: number; owner: components["schemas"]["simple-user"]; /** @@ -23057,6 +23915,10 @@ export interface components { }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ access_granted_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -23485,7 +24347,7 @@ export interface components { allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -23893,7 +24755,8 @@ export interface components { */ actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. + * @default always * @enum {string} */ bypass_mode: "always" | "pull_request"; @@ -23963,7 +24826,9 @@ export interface components { }; /** * Organization ruleset conditions - * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. + * @description Conditions for an organization ruleset. + * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + * The push rulesets conditions object does not require the `ref_name` property. */ "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24052,6 +24917,18 @@ export interface components { /** @enum {string} */ type: "required_signatures"; }; + /** + * RequiredReviewerConfiguration + * @description A reviewing team, and file patterns describing which files they must approve changes to. + */ + "repository-rule-params-required-reviewer-configuration": { + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files. */ + file_patterns: string[]; + /** @description Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. */ + minimum_approvals: number; + /** @description Node ID of the team which must review changes to matching files. */ + reviewer_id: string; + }; /** * pull_request * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -24351,7 +25228,7 @@ export interface components { html?: { /** @description The html URL of the ruleset */ href?: string; - }; + } | null; }; conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; rules?: components["schemas"]["repository-rule"][]; @@ -26462,6 +27339,7 @@ export interface components { received_events_url?: string; type?: string; site_admin?: boolean; + user_view_type?: string; }[]; teams: { id?: number; @@ -26517,6 +27395,8 @@ export interface components { type?: string; /** @example false */ site_admin?: boolean; + /** @example public */ + user_view_type?: string; }; name?: string; client_id?: string; @@ -27067,7 +27947,10 @@ export interface components { * @description A suite of checks performed on the code of a given code change */ "check-suite": { - /** @example 5 */ + /** + * Format: int64 + * @example 5 + */ id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ node_id: string; @@ -27687,6 +28570,8 @@ export interface components { }; /** @example admin */ role_name: string; + /** @example public */ + user_view_type?: string; }; /** * Repository Invitation @@ -27802,6 +28687,8 @@ export interface components { }; /** @example admin */ role_name: string; + /** @example public */ + user_view_type?: string; } | null; /** * Repository Collaborator Permission @@ -28175,6 +29062,7 @@ export interface components { name: string; path: string; sha: string; + content?: string; /** Format: uri */ url: string; /** Format: uri */ @@ -28188,7 +29076,6 @@ export interface components { size: number; name: string; path: string; - content?: string; sha: string; /** Format: uri */ url: string; @@ -28250,7 +29137,10 @@ export interface components { * @description Content File */ "content-file": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ type: "file"; encoding: string; size: number; @@ -28284,7 +29174,10 @@ export interface components { * @description An object describing a symlink */ "content-symlink": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ type: "symlink"; target: string; size: number; @@ -28313,7 +29206,10 @@ export interface components { * @description An object describing a submodule */ "content-submodule": { - /** @enum {string} */ + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ type: "submodule"; /** Format: uri */ submodule_git_url: string; @@ -28442,6 +29338,7 @@ export interface components { contributions: number; email?: string; name?: string; + user_view_type?: string; }; /** @description A Dependabot alert. */ "dependabot-alert": { @@ -28548,6 +29445,11 @@ export interface components { * @example SPDX-2.3 */ spdxVersion: string; + /** + * @description An optional comment about the SPDX document. + * @example Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/ + */ + comment?: string; creationInfo: { /** * @description The date and time the SPDX document was created. @@ -28567,11 +29469,9 @@ export interface components { * @example CC0-1.0 */ dataLicense: string; - /** @description The name of the repository that the SPDX document describes. */ - documentDescribes: string[]; /** * @description The namespace for the SPDX document. - * @example https://github.com/example/dependency_graph/sbom-123 + * @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 */ documentNamespace: string; packages: { @@ -28582,7 +29482,7 @@ export interface components { SPDXID?: string; /** * @description The name of the package. - * @example rubygems:github/github + * @example github/github */ name?: string; /** @@ -28642,6 +29542,17 @@ export interface components { referenceType: string; }[]; }[]; + relationships?: { + /** + * @description The type of relationship between the two SPDX elements. + * @example DEPENDS_ON + */ + relationshipType?: string; + /** @description The SPDX identifier of the package that is the source of the relationship. */ + spdxElementId?: string; + /** @description The SPDX identifier of the package that is the target of the relationship. */ + relatedSpdxElement?: string; + }[]; }; }; /** @@ -28797,7 +29708,7 @@ export interface components { environment: string; /** * Format: uri - * @description Deprecated: the URL to associate with this status. + * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ @@ -30159,12 +31070,12 @@ export interface components { */ path: string; /** - * @description The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. + * @description The line index in the diff to which the comment applies. This field is closing down; use `line` instead. * @example 1 */ position?: number; /** - * @description The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. + * @description The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. * @example 4 */ original_position?: number; @@ -30364,6 +31275,7 @@ export interface components { read_only: boolean; added_by?: string | null; last_used?: string | null; + enabled?: boolean; }; /** * Language @@ -30824,361 +31736,16 @@ export interface components { head: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: { - key: string; - name: string; - /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; - } | null; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; - web_commit_signoff_required?: boolean; - } | null; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - /** Format: int64 */ - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; base: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: components["schemas"]["nullable-license-simple"]; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - web_commit_signoff_required?: boolean; - }; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - /** Format: int64 */ - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; _links: { comments: components["schemas"]["link"]; @@ -31552,6 +32119,10 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + multi_repo?: boolean | null; }; /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ "secret-scanning-alert-resolution-comment": string | null; @@ -32446,6 +33017,7 @@ export interface components { company?: string | null; /** Format: date-time */ suspended_at?: string | null; + user_view_type?: string; }; /** * Private User @@ -32459,6 +33031,11 @@ export interface components { * @example 1 */ id: number; + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + user_view_type: "private"; /** @example MDQ6VXNlcjE= */ node_id: string; /** @@ -32573,8 +33150,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; business_plus?: boolean; ldap_dn?: string; }; @@ -33614,7 +34189,7 @@ export interface components { allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -33675,75 +34250,6 @@ export interface components { /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; }; - /** - * Simple User - * @description The GitHub user that triggered the event. This property is included in every webhook payload. - */ - "simple-user-webhooks": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** @example 1 */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; - /** - * Format: uri - * @example https://api.github.com/users/octocat - */ - url: string; - /** - * Format: uri - * @example https://github.com/octocat - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/followers - */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions - */ - subscriptions_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs - */ - organizations_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/repos - */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events - */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - }; /** * branch protection rule * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. @@ -33916,6 +34422,7 @@ export interface components { /** Format: uri */ url: string; verified: boolean; + enabled?: boolean; }; /** Workflow */ webhooks_workflow: { @@ -33954,6 +34461,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; webhooks_reviewers: { /** User */ @@ -34043,6 +34551,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; webhooks_answer: { /** @@ -34114,6 +34623,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -34159,6 +34669,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; answer_html_url: string | null; /** @@ -34258,6 +34769,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; labels?: components["schemas"]["label"][]; }; @@ -34329,6 +34841,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Label */ @@ -34458,6 +34971,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The changes to the comment. */ @@ -34510,6 +35024,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -34546,6 +35061,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -34633,6 +35149,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -34715,6 +35232,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -34876,6 +35394,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -34924,6 +35443,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -34992,6 +35512,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -35028,6 +35549,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -35115,6 +35637,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -35197,6 +35720,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -35358,6 +35882,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** User */ @@ -35396,6 +35921,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Marketplace Purchase */ webhooks_marketplace_purchase: { @@ -35975,7 +36501,7 @@ export interface components { allow_update_branch: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -36082,6 +36608,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36155,6 +36682,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -36221,6 +36749,10 @@ export interface components { }[] | null; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -36276,6 +36808,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -36332,6 +36865,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ html_url: string; @@ -36551,7 +37085,7 @@ export interface components { */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ use_squash_pr_title_as_default: boolean; @@ -36639,6 +37173,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36727,6 +37262,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -36950,6 +37486,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -37059,6 +37596,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -37294,6 +37832,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -37403,6 +37942,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -37470,6 +38010,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -37517,6 +38058,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -37740,6 +38282,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -37886,6 +38429,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The review that was affected. */ @@ -37959,6 +38503,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; webhooks_nullable_string: string | null; @@ -38065,6 +38610,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -38212,6 +38758,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -38361,6 +38908,10 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + multi_repo?: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { @@ -38421,6 +38972,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; node_id: string; privacy_level: string; @@ -38460,6 +39012,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** User */ sponsorable: { @@ -38497,6 +39050,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Sponsorship Tier @@ -38608,7 +39162,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection configuration enabled event */ "webhook-branch-protection-configuration-enabled": { @@ -38618,7 +39172,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule created event */ "webhook-branch-protection-rule-created": { @@ -38629,7 +39183,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ "webhook-branch-protection-rule-deleted": { @@ -38640,7 +39194,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ "webhook-branch-protection-rule-edited": { @@ -38691,7 +39245,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ "webhook-check-run-completed": { @@ -38701,7 +39255,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event @@ -38719,7 +39273,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event @@ -38742,7 +39296,7 @@ export interface components { /** @description The integrator reference of the action requested by the user. */ identifier?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event @@ -38760,7 +39314,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event @@ -38834,6 +39388,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39011,7 +39566,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite requested event */ "webhook-check-suite-requested": { @@ -39077,6 +39632,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39254,7 +39810,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite rerequested event */ "webhook-check-suite-rerequested": { @@ -39320,6 +39876,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39497,7 +40054,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert appeared_in_branch event */ "webhook-code-scanning-alert-appeared-in-branch": { @@ -39551,6 +40108,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -39623,7 +40181,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ "webhook-code-scanning-alert-closed-by-user": { @@ -39677,6 +40235,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -39756,7 +40315,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ "webhook-code-scanning-alert-created": { @@ -39831,9 +40390,9 @@ export interface components { }; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - state: "open" | "dismissed"; + state: "open" | "dismissed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -39851,7 +40410,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ "webhook-code-scanning-alert-fixed": { @@ -39905,6 +40464,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -39986,7 +40546,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ "webhook-code-scanning-alert-reopened": { @@ -40079,7 +40639,7 @@ export interface components { /** @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. */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ "webhook-code-scanning-alert-reopened-by-user": { @@ -40163,7 +40723,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** commit_comment created event */ "webhook-commit-comment-created": { @@ -40172,7 +40732,7 @@ export interface components { * @enum {string} */ action: "created"; - /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ + /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ comment: { /** * AuthorAssociation @@ -40251,13 +40811,14 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** create event */ "webhook-create": { @@ -40276,7 +40837,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** custom property created event */ "webhook-custom-property-created": { @@ -40286,7 +40847,7 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property deleted event */ "webhook-custom-property-deleted": { @@ -40299,7 +40860,7 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property updated event */ "webhook-custom-property-updated": { @@ -40309,7 +40870,7 @@ export interface components { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Custom property values updated event */ "webhook-custom-property-values-updated": { @@ -40319,7 +40880,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; repository: components["schemas"]["repository-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description The new custom property values for the repository. */ new_property_values: components["schemas"]["custom-property-value"][]; /** @description The old custom property values for the repository. */ @@ -40338,7 +40899,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-dismissed event */ "webhook-dependabot-alert-auto-dismissed": { @@ -40349,7 +40910,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-reopened event */ "webhook-dependabot-alert-auto-reopened": { @@ -40360,7 +40921,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ "webhook-dependabot-alert-created": { @@ -40371,7 +40932,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ "webhook-dependabot-alert-dismissed": { @@ -40382,7 +40943,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ "webhook-dependabot-alert-fixed": { @@ -40393,7 +40954,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ "webhook-dependabot-alert-reintroduced": { @@ -40404,7 +40965,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ "webhook-dependabot-alert-reopened": { @@ -40415,7 +40976,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ "webhook-deploy-key-created": { @@ -40426,7 +40987,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ "webhook-deploy-key-deleted": { @@ -40437,7 +40998,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deployment created event */ "webhook-deployment-created": { @@ -40485,6 +41046,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -40547,6 +41109,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40643,7 +41206,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run: { @@ -40683,6 +41246,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -40917,6 +41481,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -40944,7 +41509,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; installation?: components["schemas"]["simple-installation"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-deployment-review-approved": { /** @enum {string} */ @@ -40956,7 +41521,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -41007,6 +41572,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -41075,6 +41641,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -41185,6 +41752,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -41241,6 +41809,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -41260,7 +41829,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -41311,6 +41880,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -41378,6 +41948,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -41488,6 +42059,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -41544,6 +42116,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -41600,11 +42173,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @enum {string} */ type?: "User" | "Team"; }[]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { conclusion: unknown; @@ -41654,6 +42228,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -41721,6 +42296,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -41831,6 +42407,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -41887,6 +42464,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -41973,6 +42551,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -42035,6 +42614,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42166,6 +42746,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ deployment_url: string; @@ -42233,6 +42814,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42326,7 +42908,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run?: { @@ -42366,6 +42948,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -42600,6 +43183,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -42619,7 +43203,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion category changed event */ "webhook-discussion-category-changed": { @@ -42647,7 +43231,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion closed event */ "webhook-discussion-closed": { @@ -42658,7 +43242,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment created event */ "webhook-discussion-comment-created": { @@ -42670,7 +43254,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment deleted event */ "webhook-discussion-comment-deleted": { @@ -42682,7 +43266,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment edited event */ "webhook-discussion-comment-edited": { @@ -42699,7 +43283,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion created event */ "webhook-discussion-created": { @@ -42710,7 +43294,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion deleted event */ "webhook-discussion-deleted": { @@ -42721,7 +43305,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion edited event */ "webhook-discussion-edited": { @@ -42740,7 +43324,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion labeled event */ "webhook-discussion-labeled": { @@ -42752,7 +43336,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ "webhook-discussion-locked": { @@ -42763,7 +43347,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion pinned event */ "webhook-discussion-pinned": { @@ -42774,7 +43358,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion reopened event */ "webhook-discussion-reopened": { @@ -42785,7 +43369,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion transferred event */ "webhook-discussion-transferred": { @@ -42800,7 +43384,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unanswered event */ "webhook-discussion-unanswered": { @@ -42810,7 +43394,7 @@ export interface components { old_answer: components["schemas"]["webhooks_answer"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ "webhook-discussion-unlabeled": { @@ -42822,7 +43406,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ "webhook-discussion-unlocked": { @@ -42833,7 +43417,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unpinned event */ "webhook-discussion-unpinned": { @@ -42844,7 +43428,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * fork event @@ -43040,6 +43624,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -43191,13 +43776,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ "webhook-github-app-authorization-revoked": { /** @enum {string} */ action: "revoked"; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** gollum event */ "webhook-gollum": { @@ -43225,7 +43810,7 @@ export interface components { title: string; }[]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation created event */ "webhook-installation-created": { @@ -43237,7 +43822,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ "webhook-installation-deleted": { @@ -43249,7 +43834,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ "webhook-installation-new-permissions-accepted": { @@ -43261,7 +43846,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ "webhook-installation-repositories-added": { @@ -43285,7 +43870,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ "webhook-installation-repositories-removed": { @@ -43309,7 +43894,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ "webhook-installation-suspend": { @@ -43321,7 +43906,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { @@ -43361,6 +43946,7 @@ export interface components { updated_at?: string; url?: string; website_url?: unknown; + user_view_type?: string; }; /** @enum {string} */ action: "renamed"; @@ -43376,7 +43962,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; target_type: string; }; /** installation unsuspend event */ @@ -43389,7 +43975,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ "webhook-issue-comment-created": { @@ -43479,6 +44065,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -43523,6 +44110,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -43559,6 +44147,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -43646,6 +44235,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -43728,6 +44318,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -43889,6 +44480,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -43928,6 +44520,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: Record[]; author_association?: string; @@ -44006,7 +44599,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ "webhook-issue-comment-deleted": { @@ -44055,6 +44648,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -44091,6 +44685,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -44178,6 +44773,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -44260,6 +44856,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -44421,6 +45018,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -44460,6 +45058,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: Record[]; author_association?: string; @@ -44534,11 +45133,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment edited event */ "webhook-issue-comment-edited": { @@ -44588,6 +45188,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -44624,6 +45225,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -44711,6 +45313,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -44793,6 +45396,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -44954,6 +45558,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -44993,6 +45598,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: Record[]; author_association?: string; @@ -45071,7 +45677,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues assigned event */ "webhook-issues-assigned": { @@ -45086,7 +45692,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues closed event */ "webhook-issues-closed": { @@ -45137,6 +45743,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -45173,6 +45780,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -45260,6 +45868,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -45342,6 +45951,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -45503,6 +46113,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -45563,11 +46174,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues deleted event */ "webhook-issues-deleted": { @@ -45618,6 +46230,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -45741,6 +46354,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -45823,6 +46437,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -45984,11 +46599,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues demilestoned event */ "webhook-issues-demilestoned": { @@ -46162,6 +46778,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -46244,6 +46861,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -46405,12 +47023,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues edited event */ "webhook-issues-edited": { @@ -46472,6 +47091,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46595,6 +47215,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -46677,6 +47298,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -46838,12 +47460,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues labeled event */ "webhook-issues-labeled": { @@ -46894,6 +47517,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47017,6 +47641,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -47099,6 +47724,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -47260,12 +47886,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues locked event */ "webhook-issues-locked": { @@ -47316,6 +47943,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47352,6 +47980,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47440,6 +48069,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -47522,6 +48152,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -47683,11 +48314,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ "webhook-issues-milestoned": { @@ -47861,6 +48493,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -47943,6 +48576,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -48104,12 +48738,13 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues opened event */ "webhook-issues-opened": { @@ -48159,6 +48794,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48195,6 +48831,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48282,6 +48919,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -48364,6 +49002,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -48525,6 +49164,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } | null; /** @@ -48724,6 +49364,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -48819,6 +49460,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48855,6 +49497,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48942,6 +49585,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49024,6 +49668,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -49185,11 +49830,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ "webhook-issues-pinned": { @@ -49200,7 +49846,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ "webhook-issues-reopened": { @@ -49374,6 +50020,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49456,6 +50103,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -49617,11 +50265,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ "webhook-issues-transferred": { @@ -49671,6 +50320,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -49707,6 +50357,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -49794,6 +50445,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49876,6 +50528,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -50037,6 +50690,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -50239,6 +50893,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50294,7 +50949,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ "webhook-issues-unassigned": { @@ -50309,7 +50964,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ "webhook-issues-unlabeled": { @@ -50321,7 +50976,7 @@ export interface components { label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ "webhook-issues-unlocked": { @@ -50372,6 +51027,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -50408,6 +51064,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -50496,6 +51153,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -50578,6 +51236,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -50739,11 +51398,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ "webhook-issues-unpinned": { @@ -50754,7 +51414,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label created event */ "webhook-label-created": { @@ -50765,7 +51425,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ "webhook-label-deleted": { @@ -50776,7 +51436,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label edited event */ "webhook-label-edited": { @@ -50802,7 +51462,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase cancelled event */ "webhook-marketplace-purchase-cancelled": { @@ -50815,7 +51475,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase changed event */ "webhook-marketplace-purchase-changed": { @@ -50854,7 +51514,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change event */ "webhook-marketplace-purchase-pending-change": { @@ -50893,7 +51553,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change_cancelled event */ "webhook-marketplace-purchase-pending-change-cancelled": { @@ -50932,7 +51592,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase purchased event */ "webhook-marketplace-purchase-purchased": { @@ -50945,7 +51605,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member added event */ "webhook-member-added": { @@ -50970,7 +51630,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member edited event */ "webhook-member-edited": { @@ -50992,7 +51652,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member removed event */ "webhook-member-removed": { @@ -51003,7 +51663,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** membership added event */ "webhook-membership-added": { @@ -51055,6 +51715,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -51108,6 +51769,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -51118,7 +51780,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-merge-group-destroyed": { /** @enum {string} */ @@ -51132,7 +51794,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** meta deleted event */ "webhook-meta-deleted": { @@ -51162,7 +51824,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ "webhook-milestone-closed": { @@ -51173,7 +51835,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone created event */ "webhook-milestone-created": { @@ -51184,7 +51846,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ "webhook-milestone-deleted": { @@ -51195,7 +51857,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ "webhook-milestone-edited": { @@ -51221,7 +51883,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ "webhook-milestone-opened": { @@ -51232,7 +51894,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block blocked event */ "webhook-org-block-blocked": { @@ -51243,7 +51905,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block unblocked event */ "webhook-org-block-unblocked": { @@ -51254,7 +51916,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization deleted event */ "webhook-organization-deleted": { @@ -51265,7 +51927,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ "webhook-organization-member-added": { @@ -51276,7 +51938,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ "webhook-organization-member-invited": { @@ -51331,6 +51993,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; login: string | null; node_id: string; @@ -51340,7 +52003,7 @@ export interface components { }; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ @@ -51352,7 +52015,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ "webhook-organization-renamed": { @@ -51368,7 +52031,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ "webhook-rubygems-metadata": { @@ -51442,6 +52105,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -51481,6 +52145,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body?: string | Record; body_html?: string; @@ -51609,6 +52274,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -51644,7 +52310,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** package updated event */ "webhook-package-updated": { @@ -51699,6 +52365,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -51738,6 +52405,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string; body_html: string; @@ -51809,6 +52477,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -51845,7 +52514,7 @@ export interface components { updated_at: string; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** page_build event */ "webhook-page-build": { @@ -51893,6 +52562,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; status: string; updated_at: string; @@ -51904,7 +52574,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** personal_access_token_request approved event */ "webhook-personal-access-token-request-approved": { @@ -51913,7 +52583,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request cancelled event */ @@ -51923,7 +52593,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request created event */ @@ -51933,7 +52603,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation?: components["schemas"]["simple-installation"]; }; /** personal_access_token_request denied event */ @@ -51943,7 +52613,7 @@ export interface components { personal_access_token_request: components["schemas"]["personal-access-token-request"]; organization: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; "webhook-ping": { @@ -51990,7 +52660,7 @@ export interface components { hook_id?: number; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ zen?: string; }; @@ -52013,7 +52683,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card created event */ "webhook-project-card-created": { @@ -52024,7 +52694,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ "webhook-project-card-deleted": { @@ -52081,6 +52751,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -52094,7 +52765,7 @@ export interface components { url: string; }; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ "webhook-project-card-edited": { @@ -52110,7 +52781,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ "webhook-project-card-moved": { @@ -52171,6 +52842,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -52216,7 +52888,7 @@ export interface components { url?: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project closed event */ "webhook-project-closed": { @@ -52227,7 +52899,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_column created event */ "webhook-project-column-created": { @@ -52238,7 +52910,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ "webhook-project-column-deleted": { @@ -52249,7 +52921,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ "webhook-project-column-edited": { @@ -52265,7 +52937,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ "webhook-project-column-moved": { @@ -52276,7 +52948,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project created event */ "webhook-project-created": { @@ -52287,7 +52959,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project deleted event */ "webhook-project-deleted": { @@ -52298,7 +52970,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project edited event */ "webhook-project-edited": { @@ -52320,7 +52992,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ "webhook-project-reopened": { @@ -52331,7 +53003,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ "webhook-projects-v2-project-closed": { @@ -52340,7 +53012,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ "webhook-projects-v2-project-created": { @@ -52349,7 +53021,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ "webhook-projects-v2-project-deleted": { @@ -52358,7 +53030,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ "webhook-projects-v2-project-edited": { @@ -52385,7 +53057,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ "webhook-projects-v2-item-archived": { @@ -52395,7 +53067,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ "webhook-projects-v2-item-converted": { @@ -52410,7 +53082,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ "webhook-projects-v2-item-created": { @@ -52419,7 +53091,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ "webhook-projects-v2-item-deleted": { @@ -52428,7 +53100,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ "webhook-projects-v2-item-edited": { @@ -52454,7 +53126,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ "webhook-projects-v2-item-reordered": { @@ -52469,7 +53141,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ "webhook-projects-v2-item-restored": { @@ -52479,7 +53151,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ "webhook-projects-v2-project-reopened": { @@ -52488,7 +53160,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Created Event */ "webhook-projects-v2-status-update-created": { @@ -52497,7 +53169,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Deleted Event */ "webhook-projects-v2-status-update-deleted": { @@ -52506,7 +53178,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Edited Event */ "webhook-projects-v2-status-update-edited": { @@ -52539,7 +53211,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** public event */ "webhook-public": { @@ -52547,7 +53219,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request assigned event */ "webhook-pull-request-assigned": { @@ -52641,6 +53313,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -52677,6 +53350,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -52729,6 +53403,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -52952,6 +53627,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53012,7 +53688,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -53061,6 +53737,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -53296,6 +53973,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53356,7 +54034,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -53405,6 +54083,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -53472,6 +54151,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -53519,6 +54199,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -53585,6 +54266,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -53742,10 +54424,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ "webhook-pull-request-auto-merge-disabled": { @@ -53838,6 +54521,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -53926,6 +54610,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -54149,6 +54834,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54209,7 +54895,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -54258,6 +54944,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -54493,6 +55180,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54553,7 +55241,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -54602,6 +55290,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -54669,6 +55358,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -54716,6 +55406,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -54782,6 +55473,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -54939,11 +55631,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ "webhook-pull-request-auto-merge-enabled": { @@ -55036,6 +55729,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -55124,6 +55818,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -55347,6 +56042,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55407,7 +56103,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -55456,6 +56152,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -55688,6 +56385,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55748,7 +56446,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -55797,6 +56495,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -55864,6 +56563,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -55911,6 +56611,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -55977,6 +56678,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -56134,11 +56836,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason?: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ "webhook-pull-request-closed": { @@ -56150,7 +56853,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ "webhook-pull-request-converted-to-draft": { @@ -56162,7 +56865,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ "webhook-pull-request-demilestoned": { @@ -56174,7 +56877,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request dequeued event */ "webhook-pull-request-dequeued": { @@ -56267,6 +56970,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -56355,6 +57059,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -56578,6 +57283,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56638,7 +57344,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -56687,6 +57393,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -56922,6 +57629,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56982,7 +57690,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -57031,6 +57739,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -57098,6 +57807,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -57145,6 +57855,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -57211,6 +57922,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -57368,11 +58080,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - reason: string; + /** @enum {string} */ + reason: "UNKNOWN_REMOVAL_REASON" | "MANUAL" | "MERGE" | "MERGE_CONFLICT" | "CI_FAILURE" | "CI_TIMEOUT" | "ALREADY_MERGED" | "QUEUE_CLEARED" | "ROLL_BACK" | "BRANCH_PROTECTIONS" | "GIT_TREE_INVALID" | "INVALID_MERGE_COMMIT"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request edited event */ "webhook-pull-request-edited": { @@ -57403,7 +58117,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request enqueued event */ "webhook-pull-request-enqueued": { @@ -57496,6 +58210,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -57584,6 +58299,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -57807,6 +58523,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57867,7 +58584,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -57916,6 +58633,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -58151,6 +58869,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58211,7 +58930,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -58260,6 +58979,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -58327,6 +59047,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -58374,6 +59095,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -58440,6 +59162,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -58597,10 +59320,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ "webhook-pull-request-labeled": { @@ -58694,6 +59418,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -58782,6 +59507,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -59005,6 +59731,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59065,7 +59792,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -59114,6 +59841,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -59349,6 +60077,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59409,7 +60138,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -59458,6 +60187,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -59525,6 +60255,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -59572,6 +60303,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -59638,6 +60370,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -59795,10 +60528,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ "webhook-pull-request-locked": { @@ -59891,6 +60625,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -59979,6 +60714,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -60202,6 +60938,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60262,7 +60999,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -60311,6 +61048,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -60546,6 +61284,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60606,7 +61345,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -60655,6 +61394,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -60722,6 +61462,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -60769,6 +61510,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -60835,6 +61577,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -60992,10 +61735,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ "webhook-pull-request-milestoned": { @@ -61007,7 +61751,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ "webhook-pull-request-opened": { @@ -61019,7 +61763,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ "webhook-pull-request-ready-for-review": { @@ -61031,7 +61775,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ "webhook-pull-request-reopened": { @@ -61043,7 +61787,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ "webhook-pull-request-review-comment-created": { @@ -61193,6 +61937,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -61279,6 +62024,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -61367,6 +62113,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -61590,6 +62337,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61650,7 +62398,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -61699,6 +62447,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -61927,6 +62676,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61987,7 +62737,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -62036,6 +62786,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -62107,6 +62858,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -62171,6 +62923,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -62322,10 +63075,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ "webhook-pull-request-review-comment-deleted": { @@ -62416,6 +63170,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -62504,6 +63259,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -62727,6 +63483,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62787,7 +63544,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -62836,6 +63593,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -63064,6 +63822,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63124,7 +63883,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -63173,6 +63932,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -63244,6 +64004,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -63308,6 +64069,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -63459,10 +64221,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ "webhook-pull-request-review-comment-edited": { @@ -63554,6 +64317,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -63590,6 +64354,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -63642,6 +64407,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -63865,6 +64631,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63925,7 +64692,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -63974,6 +64741,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -64202,6 +64970,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64262,7 +65031,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -64311,6 +65080,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -64382,6 +65152,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -64446,6 +65217,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -64595,12 +65367,13 @@ export interface components { subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; + user_view_type?: string; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ "webhook-pull-request-review-dismissed": { @@ -64691,6 +65464,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -64779,6 +65553,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -65002,6 +65777,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65062,7 +65838,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -65111,6 +65887,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -65339,6 +66116,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65399,7 +66177,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -65448,6 +66226,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -65519,6 +66298,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -65583,6 +66363,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -65734,6 +66515,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -65809,9 +66591,10 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ "webhook-pull-request-review-edited": { @@ -65908,6 +66691,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -65996,6 +66780,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -66197,6 +66982,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66282,6 +67068,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -66488,6 +67275,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66573,6 +67361,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -66644,6 +67433,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -66708,6 +67498,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -66859,11 +67650,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ "webhook-pull-request-review-request-removed": { @@ -66957,6 +67749,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -66993,6 +67786,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -67045,6 +67839,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -67268,6 +68063,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67321,7 +68117,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -67370,6 +68166,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -67605,6 +68402,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67665,7 +68463,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -67714,6 +68512,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -67781,6 +68580,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -67828,6 +68628,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -67894,6 +68695,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -68051,6 +68853,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -68090,8 +68893,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ action: "review_request_removed"; @@ -68183,6 +68987,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -68219,6 +69024,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -68271,6 +69077,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -68494,6 +69301,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68554,7 +69362,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -68603,6 +69411,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -68838,6 +69647,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68898,7 +69708,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -68947,6 +69757,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -69014,6 +69825,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -69061,6 +69873,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -69127,6 +69940,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -69284,6 +70098,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -69342,7 +70157,7 @@ export interface components { */ url: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_requested event */ "webhook-pull-request-review-requested": { @@ -69436,6 +70251,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -69472,6 +70288,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -69524,6 +70341,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -69747,6 +70565,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69807,7 +70626,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -69856,6 +70675,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -70091,6 +70911,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -70151,7 +70972,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -70200,6 +71021,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -70267,6 +71089,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -70314,6 +71137,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -70380,6 +71204,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -70537,6 +71362,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -70576,8 +71402,9 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ action: "review_requested"; @@ -70669,6 +71496,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -70705,6 +71533,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -70757,6 +71586,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -70980,6 +71810,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71040,7 +71871,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -71089,6 +71920,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -71324,6 +72156,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71384,7 +72217,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -71433,6 +72266,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -71500,6 +72334,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -71547,6 +72382,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -71613,6 +72449,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -71770,6 +72607,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -71828,7 +72666,7 @@ export interface components { */ url?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review submitted event */ "webhook-pull-request-review-submitted": { @@ -71919,6 +72757,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -72007,6 +72846,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -72230,6 +73070,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72290,7 +73131,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -72339,6 +73180,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -72567,6 +73409,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72627,7 +73470,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -72676,6 +73519,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -72747,6 +73591,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -72811,6 +73656,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -72962,11 +73808,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ "webhook-pull-request-review-thread-resolved": { @@ -73057,6 +73904,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -73145,6 +73993,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -73351,6 +74200,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73438,6 +74288,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -73649,6 +74500,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73736,6 +74588,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -73807,6 +74660,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -73871,6 +74725,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -74022,10 +74877,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -74167,6 +75023,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -74261,6 +75118,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -74349,6 +75207,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -74555,6 +75414,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -74642,6 +75502,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -74853,6 +75714,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -74940,6 +75802,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -75011,6 +75874,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -75075,6 +75939,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -75226,10 +76091,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -75371,6 +76237,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -75469,6 +76336,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -75557,6 +76425,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -75780,6 +76649,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -75840,7 +76710,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -75889,6 +76759,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -76117,6 +76988,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -76177,7 +77049,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -76226,6 +77098,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -76293,6 +77166,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -76340,6 +77214,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -76406,6 +77281,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -76563,10 +77439,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ "webhook-pull-request-unassigned": { @@ -76660,6 +77537,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -76748,6 +77626,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -76971,6 +77850,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -77031,7 +77911,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -77080,6 +77960,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -77315,6 +78196,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -77375,7 +78257,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -77424,6 +78306,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -77491,6 +78374,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -77538,6 +78422,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -77604,6 +78489,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -77761,10 +78647,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ "webhook-pull-request-unlabeled": { @@ -77858,6 +78745,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -77946,6 +78834,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -78169,6 +79058,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -78229,7 +79119,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -78278,6 +79168,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -78506,6 +79397,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -78566,7 +79458,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -78615,6 +79507,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -78682,6 +79575,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -78729,6 +79623,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -78795,6 +79690,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -78952,10 +79848,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ "webhook-pull-request-unlocked": { @@ -79048,6 +79945,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -79136,6 +80034,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -79359,6 +80258,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -79419,7 +80319,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -79468,6 +80368,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -79703,6 +80604,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -79763,7 +80665,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -79812,6 +80714,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -79879,6 +80782,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -79926,6 +80830,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -79992,6 +80897,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ @@ -80149,10 +81055,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** push event */ "webhook-push": { @@ -80489,6 +81396,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -80538,7 +81446,7 @@ export interface components { /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-registry-package-published": { /** @enum {string} */ @@ -80573,6 +81481,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -80595,6 +81504,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body?: string | Record; body_html?: string; @@ -80704,6 +81614,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; created_at?: string; draft?: boolean; @@ -80734,7 +81645,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-registry-package-updated": { /** @enum {string} */ @@ -80769,6 +81680,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -80791,6 +81703,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body: string; body_html: string; @@ -80843,6 +81756,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; created_at: string; draft: boolean; @@ -80867,7 +81781,7 @@ export interface components { updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release created event */ "webhook-release-created": { @@ -80878,7 +81792,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release deleted event */ "webhook-release-deleted": { @@ -80889,7 +81803,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release edited event */ "webhook-release-edited": { @@ -80914,7 +81828,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ "webhook-release-prereleased": { @@ -81026,6 +81940,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -81074,7 +81989,7 @@ export interface components { zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release published event */ "webhook-release-published": { @@ -81085,7 +82000,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release released event */ "webhook-release-released": { @@ -81096,7 +82011,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ "webhook-release-unpublished": { @@ -81107,7 +82022,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory published event */ "webhook-repository-advisory-published": { @@ -81118,7 +82033,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory reported event */ "webhook-repository-advisory-reported": { @@ -81129,7 +82044,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ "webhook-repository-archived": { @@ -81139,7 +82054,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository created event */ "webhook-repository-created": { @@ -81149,7 +82064,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository deleted event */ "webhook-repository-deleted": { @@ -81159,7 +82074,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { @@ -81174,7 +82089,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository edited event */ "webhook-repository-edited": { @@ -81198,7 +82113,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_import event */ "webhook-repository-import": { @@ -81206,7 +82121,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @enum {string} */ status: "success" | "cancelled" | "failure"; }; @@ -81218,7 +82133,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository publicized event */ "webhook-repository-publicized": { @@ -81228,7 +82143,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository renamed event */ "webhook-repository-renamed": { @@ -81245,7 +82160,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset created event */ "webhook-repository-ruleset-created": { @@ -81256,7 +82171,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset deleted event */ "webhook-repository-ruleset-deleted": { @@ -81267,7 +82182,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset edited event */ "webhook-repository-ruleset-edited": { @@ -81325,7 +82240,7 @@ export interface components { }[]; }; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ "webhook-repository-transferred": { @@ -81396,6 +82311,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; }; @@ -81404,7 +82320,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository unarchived event */ "webhook-repository-unarchived": { @@ -81414,7 +82330,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert create event */ "webhook-repository-vulnerability-alert-create": { @@ -81425,7 +82341,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert dismiss event */ "webhook-repository-vulnerability-alert-dismiss": { @@ -81478,6 +82394,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; external_identifier: string; /** Format: uri */ @@ -81498,7 +82415,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert reopen event */ "webhook-repository-vulnerability-alert-reopen": { @@ -81509,7 +82426,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert resolve event */ "webhook-repository-vulnerability-alert-resolve": { @@ -81581,7 +82498,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** secret_scanning_alert created event */ "webhook-secret-scanning-alert-created": { @@ -81592,7 +82509,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created": { @@ -81603,13 +82520,24 @@ export interface components { location: components["schemas"]["secret-scanning-location"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created-form-encoded": { /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ payload: string; }; + /** secret_scanning_alert publicly leaked event */ + "webhook-secret-scanning-alert-publicly-leaked": { + /** @enum {string} */ + action: "publicly_leaked"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** secret_scanning_alert reopened event */ "webhook-secret-scanning-alert-reopened": { /** @enum {string} */ @@ -81619,7 +82547,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert resolved event */ "webhook-secret-scanning-alert-resolved": { @@ -81630,7 +82558,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert validated event */ "webhook-secret-scanning-alert-validated": { @@ -81641,7 +82569,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ "webhook-security-advisory-published": { @@ -81652,7 +82580,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ "webhook-security-advisory-updated": { @@ -81663,7 +82591,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ "webhook-security-advisory-withdrawn": { @@ -81711,7 +82639,7 @@ export interface components { }[]; withdrawn_at: string; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ "webhook-security-and-analysis": { @@ -81724,7 +82652,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["full-repository"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ "webhook-sponsorship-cancelled": { @@ -81734,7 +82662,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ @@ -81745,7 +82673,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ @@ -81762,7 +82690,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ @@ -81774,7 +82702,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ @@ -81787,7 +82715,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ @@ -81799,7 +82727,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ @@ -81810,7 +82738,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: string | null; }; @@ -81822,7 +82750,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: unknown; }; @@ -81986,7 +82914,7 @@ export interface components { name: string; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ sha: string; /** @@ -82012,7 +82940,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** parent issue removed event */ "webhook-sub-issues-parent-issue-removed": { @@ -82028,7 +82956,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sub-issue added event */ "webhook-sub-issues-sub-issue-added": { @@ -82044,7 +82972,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sub-issue removed event */ "webhook-sub-issues-sub-issue-removed": { @@ -82060,7 +82988,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** team_add event */ "webhook-team-add": { @@ -82068,7 +82996,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ @@ -82273,6 +83201,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -82320,7 +83249,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ @@ -82525,6 +83454,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -82572,7 +83502,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ @@ -82777,6 +83707,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -82824,7 +83755,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ @@ -83060,6 +83991,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -83107,7 +84039,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ @@ -83312,6 +84244,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -83359,7 +84292,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ @@ -83370,7 +84303,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** workflow_dispatch event */ "webhook-workflow-dispatch": { @@ -83382,7 +84315,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: string; }; /** workflow_job completed event */ @@ -83393,7 +84326,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -83483,7 +84416,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -83581,7 +84514,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -83635,7 +84568,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -83689,7 +84622,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -83729,6 +84662,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -83879,6 +84813,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -84051,6 +84986,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -84119,6 +85055,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -84142,7 +85079,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -84590,7 +85527,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -84630,6 +85567,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -84780,6 +85718,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -84952,6 +85891,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -85020,6 +85960,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -85113,6 +86054,15 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + usage_metrics_api_disabled: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Service unavailable */ service_unavailable: { headers: { @@ -85361,6 +86311,12 @@ export interface components { "secret-scanning-alert-sort": "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ "secret-scanning-alert-validity": string; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + "secret-scanning-alert-publicly-leaked": boolean; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + "secret-scanning-alert-multi-repo": boolean; + /** @description The slug of the enterprise team name. */ + "enterprise-team-slug": string; /** @description The slug of the team name. */ "team-slug": string; /** @description The unique identifier of the gist. */ @@ -85393,6 +86349,10 @@ export interface components { org: string; /** @description The unique identifier of the repository. */ "repository-id": number; + /** @description Only return runner groups that are allowed to be used by this repository. */ + "visible-to-repository": string; + /** @description Unique identifier of the self-hosted runner group. */ + "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ "runner-id": number; /** @description The name of a self-hosted runner's custom label. */ @@ -85413,6 +86373,22 @@ export interface components { "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; + /** @description The type of the actor */ + "api-insights-actor-type": "installations" | "classic_pats" | "fine_grained_pats" | "oauth_apps" | "github_apps_user_to_server"; + /** @description The ID of the actor */ + "api-insights-actor-id": number; + /** @description The minimum timestamp to query for stats */ + "api-insights-min-timestamp": string; + /** @description The maximum timestamp to query for stats */ + "api-insights-max-timestamp": string; + /** @description The property to sort the results by. */ + "api-insights-route-stats-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[]; + /** @description The property to sort the results by. */ + "api-insights-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[]; + /** @description The ID of the user to query for stats */ + "api-insights-user-id": string; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + "api-insights-timestamp-increment": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The name of the codespace. */ @@ -85448,8 +86424,13 @@ export interface components { "personal-access-token-after": string; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ "custom-property-name": string; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + "ruleset-targets": string; /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ @@ -85542,6 +86523,8 @@ export interface components { status: "queued" | "in_progress" | "completed"; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ "git-ref": components["schemas"]["code-scanning-ref"]; + /** @description The number of the pull request for the results you want to list. */ + "pr-alias": number; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -85865,7 +86848,6 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; header?: never; path?: never; @@ -86340,7 +87322,7 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "classroom/list-accepted-assigments-for-an-assignment": { + "classroom/list-accepted-assignments-for-an-assignment": { parameters: { query?: { /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -86574,6 +87556,42 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "copilot/copilot-metrics-for-enterprise": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-enterprise": { parameters: { query?: { @@ -86697,6 +87715,10 @@ export interface operations { after?: components["parameters"]["pagination-after"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; header?: never; path: { @@ -86721,6 +87743,44 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "copilot/copilot-metrics-for-enterprise-team": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the enterprise team name. */ + team_slug: components["parameters"]["enterprise-team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-enterprise-team": { parameters: { query?: { @@ -88302,7 +89362,7 @@ export interface operations { members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -88335,7 +89395,7 @@ export interface operations { blog?: string; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88346,7 +89406,7 @@ export interface operations { advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * @@ -88357,7 +89417,7 @@ export interface operations { dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * @@ -88368,7 +89428,7 @@ export interface operations { dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88379,7 +89439,7 @@ export interface operations { dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88390,7 +89450,7 @@ export interface operations { secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated - * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. * * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * @@ -88403,6 +89463,8 @@ export interface operations { secret_scanning_push_protection_custom_link_enabled?: boolean; /** @description If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. */ secret_scanning_push_protection_custom_link?: string; + /** @description Controls whether or not deploy keys may be added and used for repositories in the organization. */ + deploy_keys_enabled_for_repositories?: boolean; }; }; }; @@ -88788,6 +89850,415 @@ export interface operations { }; }; }; + "actions/list-self-hosted-runner-groups-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description Only return runner groups that are allowed to be used by this repository. */ + visible_to_repository?: components["parameters"]["visible-to-repository"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runner_groups: components["schemas"]["runner-groups-org"][]; + }; + }; + }; + }; + }; + "actions/create-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner group. */ + name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. + * @default all + * @enum {string} + */ + visibility?: "selected" | "all" | "private"; + /** @description List of repository IDs that can access the runner group. */ + selected_repository_ids?: number[]; + /** @description List of runner IDs to add to the runner group. */ + runners?: number[]; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + allows_public_repositories?: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + restricted_to_workflows?: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + selected_workflows?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + "actions/get-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + "actions/delete-self-hosted-runner-group-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/update-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner group. */ + name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. + * @enum {string} + */ + visibility?: "selected" | "all" | "private"; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + allows_public_repositories?: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + restricted_to_workflows?: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + selected_workflows?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + "actions/list-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + }; + "actions/set-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of repository IDs that can access the runner group. */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/add-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/list-self-hosted-runners-in-group-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; + }; + }; + }; + }; + }; + "actions/set-self-hosted-runners-in-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of runner IDs to add to the runner group. */ + runners: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/add-self-hosted-runner-to-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/remove-self-hosted-runner-from-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "actions/list-self-hosted-runners-for-org": { parameters: { query?: { @@ -89962,6 +91433,25 @@ export interface operations { * @enum {string} */ secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @default disabled @@ -90166,6 +91656,24 @@ export interface operations { * @enum {string} */ secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** * @description The enablement status of secret scanning validity checks * @enum {string} @@ -90227,7 +91735,7 @@ export interface operations { * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` * @enum {string} */ - scope: "all" | "public" | "private_or_internal" | "selected"; + scope: "all" | "all_without_configurations" | "public" | "private_or_internal" | "selected"; /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ selected_repository_ids?: number[]; }; @@ -91013,6 +92521,42 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "copilot/copilot-metrics-for-organization": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-org": { parameters: { query?: { @@ -91610,45 +93154,286 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "orgs/update-webhook": { + "orgs/update-webhook": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Key/value pairs to provide settings for this webhook. */ + config?: { + url: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + /** + * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. + * @default [ + * "push" + * ] + */ + events?: string[]; + /** + * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + * @default true + */ + active?: boolean; + /** @example "web" */ + name?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-hook"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/get-webhook-config-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + }; + "orgs/update-webhook-config-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + url?: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + }; + "orgs/list-webhook-deliveries": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ + cursor?: components["parameters"]["cursor"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["hook-delivery-item"][]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/get-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["hook-delivery"]; + }; + }; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/redeliver-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/ping-webhook": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ + hook_id: components["parameters"]["hook-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "api-insights/get-route-stats-by-actor": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: components["parameters"]["api-insights-route-stats-sort"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; + /** @description The type of the actor */ + actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + actor_id: components["parameters"]["api-insights-actor-id"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** @description Key/value pairs to provide settings for this webhook. */ - config?: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - }; - /** - * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. - * @default [ - * "push" - * ] - */ - events?: string[]; - /** - * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - * @default true - */ - active?: boolean; - /** @example "web" */ - name?: string; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["api-insights-route-stats"]; }; }; }; + }; + "api-insights/get-subject-stats": { + parameters: { + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: components["parameters"]["api-insights-sort"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -91656,22 +93441,23 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-hook"]; + "application/json": components["schemas"]["api-insights-subject-stats"]; }; }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/get-webhook-config-for-org": { + "api-insights/get-summary-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; }; cookie?: never; }; @@ -91683,33 +93469,61 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - "orgs/update-webhook-config-for-org": { + "api-insights/get-summary-stats-by-user": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; + /** @description The ID of the user to query for stats */ + user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - url?: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; + }; + "api-insights/get-summary-stats-by-actor": { + parameters: { + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The type of the actor */ + actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + actor_id: components["parameters"]["api-insights-actor-id"]; + }; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -91717,26 +93531,25 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - "orgs/list-webhook-deliveries": { + "api-insights/get-time-stats": { parameters: { - query?: { - /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: components["parameters"]["per-page"]; - /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; }; cookie?: never; }; @@ -91748,23 +93561,27 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["hook-delivery-item"][]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/get-webhook-delivery": { + "api-insights/get-time-stats-by-user": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; + /** @description The ID of the user to query for stats */ + user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; @@ -91776,55 +93593,81 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["hook-delivery"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/redeliver-webhook-delivery": { + "api-insights/get-time-stats-by-actor": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; - delivery_id: components["parameters"]["delivery-id"]; + /** @description The type of the actor */ + actor_type: components["parameters"]["api-insights-actor-type"]; + /** @description The ID of the actor */ + actor_id: components["parameters"]["api-insights-actor-id"]; }; cookie?: never; }; requestBody?: never; responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; }; }; - "orgs/ping-webhook": { + "api-insights/get-user-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats */ + max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: components["parameters"]["api-insights-sort"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ - hook_id: components["parameters"]["hook-id"]; + /** @description The ID of the user to query for stats */ + user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["api-insights-user-stats"]; + }; }; - 404: components["responses"]["not_found"]; }; }; "apps/get-org-installation": { @@ -93805,7 +95648,7 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; @@ -93832,7 +95675,7 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; @@ -93879,7 +95722,7 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name. The name is case sensitive. */ + /** @description The custom property name */ custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; @@ -94191,7 +96034,7 @@ export interface operations { delete_branch_on_merge?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -94263,6 +96106,11 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + targets?: components["parameters"]["ruleset-targets"]; }; header?: never; path: { @@ -94526,6 +96374,10 @@ export interface operations { after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; header?: never; path: { @@ -94726,6 +96578,44 @@ export interface operations { }; }; }; + "copilot/copilot-metrics-for-team": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; "copilot/usage-metrics-for-team": { parameters: { query?: { @@ -94836,7 +96726,7 @@ export interface operations { */ notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -94946,7 +96836,7 @@ export interface operations { */ notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -96957,6 +98847,11 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." */ + secret_scanning_ai_detection?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_scanning_non_provider_patterns?: { /** @description Can be `enabled` or `disabled`. */ @@ -97017,7 +98912,7 @@ export interface operations { allow_update_branch?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -99799,7 +101694,7 @@ export interface operations { strict: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -100268,7 +102163,7 @@ export interface operations { strict?: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -100527,12 +102422,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ apps: string[]; - } | string[]; + }; }; }; responses: { @@ -100562,12 +102457,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ apps: string[]; - } | string[]; + }; }; }; responses: { @@ -100597,12 +102492,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ apps: string[]; - } | string[]; + }; }; }; responses: { @@ -100793,12 +102688,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ users: string[]; - } | string[]; + }; }; }; responses: { @@ -100828,12 +102723,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ users: string[]; - } | string[]; + }; }; }; responses: { @@ -100863,12 +102758,12 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ users: string[]; - } | string[]; + }; }; }; responses: { @@ -101458,8 +103353,14 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["git-ref"]; + /** @description The number of the pull request for the results you want to list. */ + pr?: components["parameters"]["pr-alias"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; /** @description The property by which to sort the results. */ sort?: "created" | "updated"; /** @description If specified, only code scanning alerts with this state will be returned. */ @@ -101571,6 +103472,8 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["git-ref"]; + /** @description The number of the pull request for the results you want to list. */ + pr?: components["parameters"]["pr-alias"]; }; header?: never; path: { @@ -101610,6 +103513,8 @@ export interface operations { page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The number of the pull request for the results you want to list. */ + pr?: components["parameters"]["pr-alias"]; /** @description The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ @@ -101770,6 +103675,34 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "code-scanning/delete-codeql-database": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The language of the CodeQL database. */ + language: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "code-scanning/create-variant-analysis": { parameters: { query?: never; @@ -102176,7 +104109,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -103069,7 +105002,7 @@ export interface operations { path?: string; /** @description Line index in the diff to comment on. */ position?: number; - /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ + /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ line?: number; }; }; @@ -103614,7 +105547,7 @@ export interface operations { direction?: components["parameters"]["direction"]; /** * @deprecated - * @description **Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. + * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. */ page?: number; /** @@ -104325,7 +106258,7 @@ export interface operations { "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ event_type: string; - /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ + /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. */ client_payload?: { [key: string]: unknown; }; @@ -106050,7 +107983,6 @@ export interface operations { per_page?: components["parameters"]["per-page"]; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; header?: never; path: { @@ -106740,7 +108672,7 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ + /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ assignee?: string | null; milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ @@ -107125,7 +109057,7 @@ export interface operations { title?: (string | number) | null; /** @description The contents of the issue. */ body?: string | null; - /** @description Username to assign to this issue. **This field is deprecated.** */ + /** @description Username to assign to this issue. **This field is closing down.** */ assignee?: string | null; /** * @description The open or closed state of the issue. @@ -109569,7 +111501,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -109681,7 +111613,7 @@ export interface operations { path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * @description **This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ position?: number; /** @@ -111096,6 +113028,11 @@ export interface operations { page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; + /** @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + * */ + targets?: components["parameters"]["ruleset-targets"]; }; header?: never; path: { @@ -111374,6 +113311,10 @@ export interface operations { after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; header?: never; path: { @@ -112736,12 +114677,12 @@ export interface operations { q: string; /** * @deprecated - * @description **This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) + * @description **This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "indexed"; /** * @deprecated - * @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + * @description **This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -113080,7 +115021,7 @@ export interface operations { */ notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -114372,7 +116313,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -114403,7 +116344,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -115232,6 +117173,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; "users/unfollow": { diff --git a/packages/openapi-typescript/examples/github-api.yaml b/packages/openapi-typescript/examples/github-api.yaml index 3ba85e979..203a43624 100644 --- a/packages/openapi-typescript/examples/github-api.yaml +++ b/packages/openapi-typescript/examples/github-api.yaml @@ -91,6 +91,8 @@ tags: description: Endpoints to manage GitHub Enterprise Teams. - name: code-security description: Endpoints to manage Code security using the REST API. +- name: private-registries + description: Manage private registry configurations. servers: - url: https://api.github.com externalDocs: @@ -502,11 +504,6 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/cursor" - - name: redelivery - in: query - required: false - schema: - type: boolean responses: '200': description: Response @@ -1188,7 +1185,7 @@ paths: the assignment. tags: - classroom - operationId: classroom/list-accepted-assigments-for-an-assignment + operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment @@ -1437,13 +1434,16 @@ paths: summary: List all Copilot seat assignments for an enterprise description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. @@ -1500,12 +1500,83 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/enterprises/{enterprise}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - name: since + description: Show usage metrics since this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). For + more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/copilot/usage": get: summary: Get a summary of Copilot usage for enterprise members description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -1515,6 +1586,8 @@ paths: and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE. + The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + Only owners and billing managers can view Copilot usage metrics for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -1660,6 +1733,8 @@ paths: - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/secret-scanning-alert-validity" + - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" + - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" responses: '200': description: Response @@ -1684,12 +1759,87 @@ paths: enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + > [!NOTE] + > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team-slug" + - name: since + description: Show usage metrics since this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). For + more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for an enterprise team description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -3911,10 +4061,10 @@ paths: summary: Update an organization description: |- > [!WARNING] - > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + > **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). > [!WARNING] - > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). Updates the organization's profile and member privileges. @@ -4009,7 +4159,7 @@ paths: description: "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** - This parameter is deprecated and will be removed in the future. + This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description @@ -4050,7 +4200,7 @@ paths: advanced_security_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. @@ -4061,7 +4211,7 @@ paths: dependabot_alerts_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. @@ -4072,7 +4222,7 @@ paths: dependabot_security_updates_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. @@ -4083,7 +4233,7 @@ paths: dependency_graph_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. @@ -4094,7 +4244,7 @@ paths: secret_scanning_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. @@ -4105,7 +4255,7 @@ paths: secret_scanning_push_protection_enabled_for_new_repositories: type: boolean description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. @@ -4122,6 +4272,10 @@ paths: description: If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. + deploy_keys_enabled_for_repositories: + type: boolean + description: Controls whether or not deploy keys may be added and + used for repositories in the organization. examples: default: value: @@ -4670,6 +4824,544 @@ paths: enabledForGitHubApps: true category: actions subcategory: permissions + "/orgs/{org}/actions/runner-groups": + get: + summary: List self-hosted runner groups for an organization + description: |- + Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/list-self-hosted-runner-groups-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/visible-to-repository" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runner_groups + properties: + total_count: + type: number + runner_groups: + type: array + items: + "$ref": "#/components/schemas/runner-groups-org" + examples: + default: + "$ref": "#/components/examples/runner-groups-org" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + post: + summary: Create a self-hosted runner group for an organization + description: |- + Creates a new self-hosted runner group for an organization. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/create-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner group. + type: string + visibility: + description: Visibility of a runner group. You can select all repositories, + select individual repositories, or limit access to private repositories. + type: string + enum: + - selected + - all + - private + default: all + selected_repository_ids: + description: List of repository IDs that can access the runner group. + type: array + items: + type: integer + description: Unique identifier of the repository. + runners: + description: List of runner IDs to add to the runner group. + type: array + items: + type: integer + description: Unique identifier of the runner. + allows_public_repositories: + description: Whether the runner group can be used by `public` repositories. + type: boolean + default: false + restricted_to_workflows: + description: If `true`, the runner group will be restricted to running + only the workflows specified in the `selected_workflows` array. + type: boolean + default: false + selected_workflows: + description: List of workflows the runner group should be allowed + to run. This setting will be ignored unless `restricted_to_workflows` + is set to `true`. + type: array + items: + type: string + description: Name of workflow the runner group should be allowed + to run. Note that a ref, tag, or long SHA is required. + example: octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - name + examples: + default: + value: + name: Expensive hardware runners + visibility: selected + selected_repository_ids: + - 32 + - 91 + runners: + - 9 + - 2 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/runner-groups-org" + examples: + default: + "$ref": "#/components/examples/runner-group" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}": + get: + summary: Get a self-hosted runner group for an organization + description: |- + Gets a specific self-hosted runner group for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/get-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/runner-groups-org" + examples: + default: + "$ref": "#/components/examples/runner-group-item" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + patch: + summary: Update a self-hosted runner group for an organization + description: |- + Updates the `name` and `visibility` of a self-hosted runner group in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/update-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner group. + type: string + visibility: + description: Visibility of a runner group. You can select all repositories, + select individual repositories, or all private repositories. + type: string + enum: + - selected + - all + - private + allows_public_repositories: + description: Whether the runner group can be used by `public` repositories. + type: boolean + default: false + restricted_to_workflows: + description: If `true`, the runner group will be restricted to running + only the workflows specified in the `selected_workflows` array. + type: boolean + default: false + selected_workflows: + description: List of workflows the runner group should be allowed + to run. This setting will be ignored unless `restricted_to_workflows` + is set to `true`. + type: array + items: + type: string + description: Name of workflow the runner group should be allowed + to run. Note that a ref, tag, or long SHA is required. + example: octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - name + examples: + default: + value: + name: Expensive hardware runners + visibility: selected + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/runner-groups-org" + examples: + default: + "$ref": "#/components/examples/runner-group" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Delete a self-hosted runner group from an organization + description: |- + Deletes a self-hosted runner group for an organization. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/delete-self-hosted-runner-group-from-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": + get: + summary: List repository access to a self-hosted runner group in an organization + description: |- + Lists the repositories with access to a self-hosted runner group configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/list-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: number + repositories: + type: array + items: + "$ref": "#/components/schemas/minimal-repository" + examples: + default: + "$ref": "#/components/examples/minimal-repository-paginated" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + put: + summary: Set repository access for a self-hosted runner group in an organization + description: |- + Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + description: List of repository IDs that can access the runner group. + type: array + items: + type: integer + description: Unique identifier of the repository. + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 32 + - 91 + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": + put: + summary: Add repository access to a self-hosted runner group in an organization + description: |- + Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/add-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Remove repository access to a self-hosted runner group in an organization + description: |- + Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/remove-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": + get: + summary: List self-hosted runners in a group for an organization + description: |- + Lists self-hosted runners that are in a specific organization group. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/list-self-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: number + runners: + type: array + items: + "$ref": "#/components/schemas/runner" + examples: + default: + "$ref": "#/components/examples/runner-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + put: + summary: Set self-hosted runners in a group for an organization + description: |- + Replaces the list of self-hosted runners that are part of an organization runner group. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-self-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + runners: + description: List of runner IDs to add to the runner group. + type: array + items: + type: integer + description: Unique identifier of the runner. + required: + - runners + examples: + default: + value: + runners: + - 9 + - 2 + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": + put: + summary: Add a self-hosted runner to a group for an organization + description: |- + Adds a self-hosted runner to a runner group configured in an organization. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/add-self-hosted-runner-to-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/runner-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Remove a self-hosted runner from a group for an organization + description: |- + Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/remove-self-hosted-runner-from-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/runner-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups "/orgs/{org}/actions/runners": get: summary: List self-hosted runners for an organization @@ -6359,6 +7051,39 @@ paths: - disabled - not_set default: disabled + secret_scanning_delegated_bypass: + type: string + description: The enablement status of secret scanning delegated + bypass + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_bypass_options: + type: object + description: Feature options for secret scanning delegated bypass + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated + bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a + bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE secret_scanning_validity_checks: type: string description: The enablement status of secret scanning validity checks @@ -6647,6 +7372,38 @@ paths: - enabled - disabled - not_set + secret_scanning_delegated_bypass: + type: string + description: The enablement status of secret scanning delegated + bypass + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass_options: + type: object + description: Feature options for secret scanning delegated bypass + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated + bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a + bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE secret_scanning_validity_checks: type: string description: The enablement status of secret scanning validity checks @@ -6769,6 +7526,7 @@ paths: the repositories specified by `selected_repository_ids` enum: - all + - all_without_configurations - public - private_or_internal - selected @@ -7568,11 +8326,11 @@ paths: summary: Get Copilot seat information and settings for an organization description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. @@ -7615,11 +8373,14 @@ paths: summary: List all Copilot seat assignments for an organization description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. - Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. Only organization owners can view assigned seats. + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot @@ -7677,16 +8438,16 @@ paths: summary: Add teams to the Copilot subscription for an organization description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for all users within each specified team. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -7729,7 +8490,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for members of the + specified team(s). properties: seats_created: type: integer @@ -7761,17 +8523,19 @@ paths: summary: Remove teams from the Copilot subscription for an organization description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for all members of each team specified. - This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all members of each team specified to "pending cancellation". + This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -7811,7 +8575,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for members of the specified team(s). properties: seats_cancelled: type: integer @@ -7844,16 +8609,16 @@ paths: summary: Add users to the Copilot subscription for an organization description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for each user specified. - The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can add Copilot seats for their organization members. In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response will contain the total number of new seats that were created and existing seats that were refreshed. @@ -7896,7 +8661,7 @@ paths: application/json: schema: type: object - description: The total number of seat assignments created. + description: The total number of seats created for the specified user(s). properties: seats_created: type: integer @@ -7928,17 +8693,19 @@ paths: summary: Remove users from the Copilot subscription for an organization description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. - Cancels the Copilot seat assignment for each user specified. - This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + Sets seats for all users specified to "pending cancellation". + This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. + The response will contain the total number of seats set to "pending cancellation". + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -7978,7 +8745,8 @@ paths: application/json: schema: type: object - description: The total number of seat assignments cancelled. + description: The total number of seats set to "pending cancellation" + for the specified users. properties: seats_cancelled: type: integer @@ -8007,12 +8775,86 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/orgs/{org}/copilot/metrics": + get: + summary: Get Copilot metrics for an organization + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - name: since + description: Show usage metrics since this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). For + more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/copilot/usage": get: summary: Get a summary of Copilot usage for organization members description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -9014,11 +9856,6 @@ paths: - "$ref": "#/components/parameters/hook-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/cursor" - - name: redelivery - in: query - required: false - schema: - type: boolean responses: '200': description: Response @@ -9141,6 +9978,292 @@ paths: enabledForGitHubApps: true category: orgs subcategory: webhooks + "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": + get: + summary: Get route stats by actor + description: Get API request count statistics for an actor broken down by route + within a specified time frame. + tags: + - orgs + operationId: api-insights/get-route-stats-by-actor + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-actor-type" + - "$ref": "#/components/parameters/api-insights-actor-id" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/api-insights-route-stats-sort" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-route-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-route-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/subject-stats": + get: + summary: Get subject stats + description: Get API request statistics for all subjects within an organization + within a specified time frame. Subjects can be users or GitHub Apps. + tags: + - orgs + operationId: api-insights/get-subject-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/api-insights-sort" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-subject-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-subject-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/summary-stats": + get: + summary: Get summary stats + description: Get overall statistics of API requests made within an organization + by all users and apps within a specified time frame. + tags: + - orgs + operationId: api-insights/get-summary-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-summary-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-summary-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/summary-stats/users/{user_id}": + get: + summary: Get summary stats by user + description: Get overall statistics of API requests within the organization + for a user. + tags: + - orgs + operationId: api-insights/get-summary-stats-by-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-user-id" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-summary-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-summary-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": + get: + summary: Get summary stats by actor + description: Get overall statistics of API requests within the organization + made by a specific actor. Actors can be GitHub App installations, OAuth apps + or other tokens on behalf of a user. + tags: + - orgs + operationId: api-insights/get-summary-stats-by-actor + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + - "$ref": "#/components/parameters/api-insights-actor-type" + - "$ref": "#/components/parameters/api-insights-actor-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-summary-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-summary-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/time-stats": + get: + summary: Get time stats + description: Get the number of API requests and rate-limited requests made within + an organization over a specified time period. + tags: + - orgs + operationId: api-insights/get-time-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-time-stats + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + - "$ref": "#/components/parameters/api-insights-timestamp-increment" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-time-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-time-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/time-stats/users/{user_id}": + get: + summary: Get time stats by user + description: Get the number of API requests and rate-limited requests made within + an organization by a specific user over a specified time period. + tags: + - orgs + operationId: api-insights/get-time-stats-by-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-user-id" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + - "$ref": "#/components/parameters/api-insights-timestamp-increment" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-time-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-time-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": + get: + summary: Get time stats by actor + description: Get the number of API requests and rate-limited requests made within + an organization by a specific actor within a specified time period. + tags: + - orgs + operationId: api-insights/get-time-stats-by-actor + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-actor-type" + - "$ref": "#/components/parameters/api-insights-actor-id" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + - "$ref": "#/components/parameters/api-insights-timestamp-increment" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-time-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-time-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + "/orgs/{org}/insights/api/user-stats/{user_id}": + get: + summary: Get user stats + description: Get API usage statistics within an organization for a user broken + down by the type of access. + tags: + - orgs + operationId: api-insights/get-user-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-user-stats + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/api-insights-user-id" + - "$ref": "#/components/parameters/api-insights-min-timestamp" + - "$ref": "#/components/parameters/api-insights-max-timestamp" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/api-insights-sort" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/api-insights-user-stats" + examples: + default: + "$ref": "#/components/examples/api-insights-user-stats" + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights "/orgs/{org}/installation": get: summary: Get an organization installation for the authenticated app @@ -9871,9 +10994,12 @@ paths: summary: Get Copilot seat assignment details for a user description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. - Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + + The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." Only organization owners can view Copilot seat assignment details for members of their organization. @@ -10854,7 +11980,7 @@ paths: description: |- Lists packages in an organization readable by the user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-organization @@ -10924,7 +12050,7 @@ paths: description: |- Gets a specific package in an organization. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-organization @@ -10957,7 +12083,7 @@ paths: The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-org @@ -10994,7 +12120,7 @@ paths: The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-org @@ -11031,7 +12157,7 @@ paths: description: |- Lists package versions for a package owned by an organization. - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-org @@ -11083,7 +12209,7 @@ paths: description: |- Gets a specific package version in an organization. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-organization @@ -11117,7 +12243,7 @@ paths: The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-org @@ -11155,7 +12281,7 @@ paths: The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-org @@ -12420,7 +13546,7 @@ paths: type: boolean description: Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property - has been deprecated. Please use `squash_merge_commit_title` instead. + is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true squash_merge_commit_title: @@ -12532,6 +13658,7 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/ruleset-targets" responses: '200': description: Response @@ -12911,6 +14038,8 @@ paths: - "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo" - "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" - "$ref": "#/components/parameters/secret-scanning-alert-validity" + - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" + - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" responses: '200': description: Response @@ -13193,12 +14322,87 @@ paths: enabledForGitHubApps: false category: billing subcategory: billing + "/orgs/{org}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for a team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - name: since + description: Show usage metrics since this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). For + more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for a team description: |- > [!NOTE] - > This endpoint is in beta and is subject to change. + > This endpoint is in public preview and is subject to change. You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -13370,7 +14574,7 @@ paths: - notifications_disabled permission: type: string - description: "**Deprecated**. The permission that new repositories + description: "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified." enum: - pull @@ -13496,7 +14700,7 @@ paths: - notifications_disabled permission: type: string - description: "**Deprecated**. The permission that new repositories + description: "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified." enum: - pull @@ -14923,7 +16127,7 @@ paths: summary: Enable or disable a security feature for an organization description: |- > [!WARNING] - > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." @@ -16007,7 +17211,7 @@ paths: * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." > [!NOTE] - > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. tags: - rate-limit operationId: rate-limit/get @@ -16164,6 +17368,16 @@ paths: status: type: string description: Can be `enabled` or `disabled`. + secret_scanning_ai_detection: + type: object + description: Use the `status` property to enable or disable + secret scanning AI detection for this repository. For more + information, see "[Responsible detection of generic secrets + with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." + properties: + status: + type: string + description: Can be `enabled` or `disabled`. secret_scanning_non_provider_patterns: type: object description: Use the `status` property to enable or disable @@ -16236,7 +17450,7 @@ paths: type: boolean description: Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property - has been deprecated. Please use `squash_merge_commit_title` instead. + is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true squash_merge_commit_title: @@ -19962,12 +21176,12 @@ paths: contexts: type: array deprecated: true - description: "**Deprecated**: The list of status checks to require - in order to merge into this branch. If any of these checks - have recently been set by a particular GitHub App, they will - be required to come from that app in future for the branch - to merge. Use `checks` instead of `contexts` for more fine-grained - control." + description: "**Closing down notice**: The list of status checks + to require in order to merge into this branch. If any of these + checks have recently been set by a particular GitHub App, + they will be required to come from that app in future for + the branch to merge. Use `checks` instead of `contexts` for + more fine-grained control." items: type: string checks: @@ -20670,11 +21884,12 @@ paths: contexts: type: array deprecated: true - description: "**Deprecated**: The list of status checks to require - in order to merge into this branch. If any of these checks have - recently been set by a particular GitHub App, they will be required - to come from that app in future for the branch to merge. Use `checks` - instead of `contexts` for more fine-grained control." + description: "**Closing down notice**: The list of status checks + to require in order to merge into this branch. If any of these + checks have recently been set by a particular GitHub App, they + will be required to come from that app in future for the branch + to merge. Use `checks` instead of `contexts` for more fine-grained + control." items: type: string checks: @@ -21105,28 +22320,24 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: - required: false + required: true content: application/json: schema: - oneOf: - - type: object - properties: - apps: - type: array - description: 'The GitHub Apps that have push access to this branch. - Use the slugified version of the app name. **Note**: The list - of users, apps, and teams in total is limited to 100 items.' - items: - type: string - required: - - apps - example: - apps: - - my-app - - type: array - items: - type: string + type: object + properties: + apps: + type: array + description: 'The GitHub Apps that have push access to this branch. + Use the slugified version of the app name. **Note**: The list + of users, apps, and teams in total is limited to 100 items.' + items: + type: string + required: + - apps + example: + apps: + - my-app examples: default: value: @@ -21169,28 +22380,24 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: - required: false + required: true content: application/json: schema: - oneOf: - - type: object - properties: - apps: - type: array - description: 'The GitHub Apps that have push access to this branch. - Use the slugified version of the app name. **Note**: The list - of users, apps, and teams in total is limited to 100 items.' - items: - type: string - required: - - apps - example: - apps: - - my-app - - type: array - items: - type: string + type: object + properties: + apps: + type: array + description: 'The GitHub Apps that have push access to this branch. + Use the slugified version of the app name. **Note**: The list + of users, apps, and teams in total is limited to 100 items.' + items: + type: string + required: + - apps + example: + apps: + - my-app examples: default: value: @@ -21233,27 +22440,24 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: + required: true content: application/json: schema: - oneOf: - - type: object - properties: - apps: - type: array - description: 'The GitHub Apps that have push access to this branch. - Use the slugified version of the app name. **Note**: The list - of users, apps, and teams in total is limited to 100 items.' - items: - type: string - required: - - apps - example: - apps: - - my-app - - type: array - items: - type: string + type: object + properties: + apps: + type: array + description: 'The GitHub Apps that have push access to this branch. + Use the slugified version of the app name. **Note**: The list + of users, apps, and teams in total is limited to 100 items.' + items: + type: string + required: + - apps + example: + apps: + - my-app examples: default: value: @@ -21563,26 +22767,22 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: - required: false + required: true content: application/json: schema: - oneOf: - - type: object - properties: - users: - type: array - description: The username for users - items: - type: string - required: - - users - example: - users: - - mona - - type: array - items: - type: string + type: object + properties: + users: + type: array + description: The username for users + items: + type: string + required: + - users + example: + users: + - mona examples: default: summary: Example adding a user in a branch protection rule @@ -21630,26 +22830,22 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: - required: false + required: true content: application/json: schema: - oneOf: - - type: object - properties: - users: - type: array - description: The username for users - items: - type: string - required: - - users - example: - users: - - mona - - type: array - items: - type: string + type: object + properties: + users: + type: array + description: The username for users + items: + type: string + required: + - users + example: + users: + - mona examples: default: summary: Example replacing a user in a branch protection rule @@ -21697,25 +22893,22 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: + required: true content: application/json: schema: - oneOf: - - type: object - properties: - users: - type: array - description: The username for users - items: - type: string - required: - - users - example: - users: - - mona - - type: array - items: - type: string + type: object + properties: + users: + type: array + description: The username for users + items: + type: string + required: + - users + example: + users: + - mona examples: default: summary: Example removing a user in a branch protection rule @@ -22028,6 +23221,8 @@ paths: required: - name - head_sha + discriminator: + propertyName: status oneOf: - properties: status: @@ -22777,7 +23972,10 @@ paths: - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/git-ref" + - "$ref": "#/components/parameters/pr-alias" - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" - name: sort description: The property by which to sort the results. in: query @@ -22945,6 +24143,7 @@ paths: - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/git-ref" + - "$ref": "#/components/parameters/pr-alias" responses: '200': description: Response @@ -22984,7 +24183,7 @@ paths: and `0` is returned in this field. > [!WARNING] - > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. operationId: code-scanning/list-recent-analyses @@ -23000,6 +24199,7 @@ paths: - "$ref": "#/components/parameters/tool-guid" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pr-alias" - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` @@ -23235,7 +24435,7 @@ paths: description: |- Lists the CodeQL databases that are available in a repository. - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/list-codeql-databases @@ -23281,7 +24481,7 @@ paths: your HTTP client is configured to follow redirects or use the `Location` header to make a second request to get the redirect URL. - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/get-codeql-database @@ -23321,6 +24521,42 @@ paths: previews: [] category: code-scanning subcategory: code-scanning + delete: + summary: Delete a CodeQL database + description: |- + Deletes a CodeQL database for a language in a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/delete-codeql-database + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: language + in: path + description: The language of the CodeQL database. + schema: + type: string + required: true + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/code_scanning_forbidden_write" + '404': + "$ref": "#/components/responses/not_found" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": post: summary: Create a CodeQL variant analysis @@ -23983,7 +25219,7 @@ paths: geo: description: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, - which is being deprecated. + which is closing down. type: string enum: - EuropeWest @@ -24371,8 +25607,6 @@ paths: Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. - Anyone with read access to the repository can use this endpoint. - If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - codespaces @@ -25326,8 +26560,8 @@ paths: description: Line index in the diff to comment on. line: type: integer - description: "**Deprecated**. Use **position** parameter instead. - Line number in the file to comment on." + description: "**Closing down notice**. Use **position** parameter + instead. Line number in the file to comment on." required: - body examples: @@ -25899,6 +27133,13 @@ paths: - "$ref": "#/components/schemas/content-file" - "$ref": "#/components/schemas/content-symlink" - "$ref": "#/components/schemas/content-submodule" + discriminator: + propertyName: type + mapping: + array: "#/components/schemas/content-directory" + file: "#/components/schemas/content-file" + symlink: "#/components/schemas/content-symlink" + submodule: "#/components/schemas/content-submodule" examples: response-if-content-is-a-file: "$ref": "#/components/examples/content-file-response-if-content-is-a-file" @@ -26236,8 +27477,8 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - name: page - description: "**Deprecated**. Page number of the results to fetch. Use cursor-based - pagination with `before` or `after` instead." + description: "**Closing down notice**. Page number of the results to fetch. + Use cursor-based pagination with `before` or `after` instead." deprecated: true in: query schema: @@ -27260,7 +28501,8 @@ paths: type: object description: JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number - of top-level properties is 10. + of top-level properties is 10. The total size of the JSON payload + must be less than 64KB. additionalProperties: true maxProperties: 10 examples: @@ -29789,11 +31031,6 @@ paths: - "$ref": "#/components/parameters/hook-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/cursor" - - name: redelivery - in: query - required: false - schema: - type: boolean responses: '200': description: Response @@ -29936,7 +31173,7 @@ paths: View the progress of an import. > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). **Import status** @@ -30009,7 +31246,7 @@ paths: return a status `422 Unprocessable Entity` response. > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/start-import @@ -30101,7 +31338,7 @@ paths: You can select the project to import by providing one of the objects in the `project_choices` array in the update request. > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/update-import @@ -30184,7 +31421,7 @@ paths: Stop an import for a repository. > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/cancel-import @@ -30216,7 +31453,7 @@ paths: This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/get-commit-authors @@ -30259,7 +31496,7 @@ paths: new commits to the repository. > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/map-commit-author @@ -30324,7 +31561,7 @@ paths: List files larger than 100MB found during the import > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/get-large-files @@ -30367,7 +31604,7 @@ paths: site](https://docs.github.com/repositories/working-with-files/managing-large-files). > [!WARNING] - > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/set-lfs-preference @@ -30818,7 +32055,7 @@ paths: description: 'Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This - field is deprecated.**_' + field is closing down.**_' nullable: true milestone: oneOf: @@ -31355,7 +32592,7 @@ paths: patch: summary: Update an issue description: |- - Issue owners and users with push access can edit an issue. + Issue owners and users with push access or Triage role can edit an issue. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -31393,7 +32630,8 @@ paths: assignee: type: string nullable: true - description: Username to assign to this issue. **This field is deprecated.** + description: Username to assign to this issue. **This field is closing + down.** state: type: string description: The open or closed state of the issue. @@ -34872,7 +36110,7 @@ paths: geo: description: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, - which is being deprecated. + which is closing down. type: string enum: - EuropeWest @@ -35006,7 +36244,7 @@ paths: If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. - The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." @@ -35047,7 +36285,7 @@ paths: description: The relative path to the file that necessitates a comment. position: type: integer - description: '**This parameter is deprecated. Use `line` instead**. + description: '**This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first @@ -36100,8 +37338,9 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": put: summary: Update a pull request branch - description: Updates the pull request branch with the latest upstream changes - by merging HEAD from the base branch into the pull request branch. + description: |- + Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. tags: - pulls operationId: pulls/update-branch @@ -37133,6 +38372,7 @@ paths: schema: type: boolean default: true + - "$ref": "#/components/parameters/ruleset-targets" responses: '200': description: Response @@ -37512,6 +38752,8 @@ paths: - "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo" - "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" - "$ref": "#/components/parameters/secret-scanning-alert-validity" + - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" + - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" responses: '200': description: Response @@ -38698,10 +39940,10 @@ paths: subcategory: repos "/repos/{owner}/{repo}/tags/protection": get: - summary: Deprecated - List tag protection states for a repository + summary: Closing down - List tag protection states for a repository description: |- > [!WARNING] - > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. This returns the tag protection states of a repository. @@ -38711,7 +39953,7 @@ paths: operationId: repos/list-tag-protection externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/tags#deprecated---list-tag-protection-states-for-a-repository + url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -38740,10 +39982,10 @@ paths: removalDate: '2024-08-30' deprecated: true post: - summary: Deprecated - Create a tag protection state for a repository + summary: Closing down - Create a tag protection state for a repository description: |- > [!WARNING] - > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. This creates a tag protection state for a repository. This endpoint is only available to repository administrators. @@ -38752,7 +39994,7 @@ paths: operationId: repos/create-tag-protection externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/tags#deprecated---create-a-tag-protection-state-for-a-repository + url: https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -38797,10 +40039,10 @@ paths: deprecated: true "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": delete: - summary: Deprecated - Delete a tag protection state for a repository + summary: Closing down - Delete a tag protection state for a repository description: |- > [!WARNING] - > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. This deletes a tag protection state for a repository. This endpoint is only available to repository administrators. @@ -38809,7 +40051,7 @@ paths: operationId: repos/delete-tag-protection externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/tags#deprecated---delete-a-tag-protection-state-for-a-repository + url: https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -39471,7 +40713,7 @@ paths: type: string - name: sort deprecated: true - description: "**This field is deprecated.** Sorts the results of your query. + description: "**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)" in: query @@ -39481,9 +40723,10 @@ paths: enum: - indexed - name: order - description: "**This field is deprecated.** Determines whether the first search - result returned is the highest number of matches (`desc`) or lowest number - of matches (`asc`). This parameter is ignored unless you provide `sort`. " + description: "**This field is closing down.** Determines whether the first + search result returned is the highest number of matches (`desc`) or lowest + number of matches (`asc`). This parameter is ignored unless you provide + `sort`. " in: query deprecated: true required: false @@ -40011,7 +41254,7 @@ paths: summary: Get a team (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. tags: - teams operationId: teams/get-legacy @@ -40044,7 +41287,7 @@ paths: summary: Update a team (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. To edit a team, the authenticated user must either be an organization owner or a team maintainer. @@ -40095,7 +41338,7 @@ paths: - notifications_disabled permission: type: string - description: "**Deprecated**. The permission that new repositories + description: "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified." enum: - pull @@ -40152,7 +41395,7 @@ paths: summary: Delete a team (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. To delete a team, the authenticated user must be an organization owner or team maintainer. @@ -40185,7 +41428,7 @@ paths: summary: List discussions (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. List all discussions on a team's page. @@ -40228,7 +41471,7 @@ paths: summary: Create a discussion (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. Creates a new discussion post on a team's page. @@ -40295,7 +41538,7 @@ paths: summary: Get a discussion (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. Get a specific discussion on a team's page. @@ -40331,7 +41574,7 @@ paths: summary: Update a discussion (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. Edits the title and body text of a discussion post. Only the parameters you provide are updated. @@ -40384,7 +41627,7 @@ paths: summary: Delete a discussion (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. Delete a discussion from a team's page. @@ -40414,7 +41657,7 @@ paths: summary: List discussion comments (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. List all comments on a team discussion. @@ -40458,7 +41701,7 @@ paths: summary: Create a discussion comment (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. Creates a new comment on a team discussion. @@ -40514,7 +41757,7 @@ paths: summary: Get a discussion comment (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. Get a specific comment on a team discussion. @@ -40551,7 +41794,7 @@ paths: summary: Update a discussion comment (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. Edits the body text of a discussion comment. @@ -40604,7 +41847,7 @@ paths: summary: Delete a discussion comment (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. Deletes a comment on a team discussion. @@ -40635,7 +41878,7 @@ paths: summary: List reactions for a team discussion comment (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). @@ -40695,7 +41938,7 @@ paths: summary: Create reaction for a team discussion comment (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). @@ -40761,7 +42004,7 @@ paths: summary: List reactions for a team discussion (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). @@ -40820,7 +42063,7 @@ paths: summary: Create reaction for a team discussion (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). @@ -40885,7 +42128,7 @@ paths: summary: List pending team invitations (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. tags: @@ -40926,7 +42169,7 @@ paths: summary: List team members (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. Team members will include the members of child teams. tags: @@ -40979,7 +42222,7 @@ paths: get: summary: Get team member (Legacy) description: |- - The "Get team member" endpoint (described below) is deprecated. + The "Get team member" endpoint (described below) is closing down. We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. @@ -41009,7 +42252,7 @@ paths: put: summary: Add team member (Legacy) description: |- - The "Add team member" endpoint (described below) is deprecated. + The "Add team member" endpoint (described below) is closing down. We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. @@ -41052,7 +42295,7 @@ paths: delete: summary: Remove team member (Legacy) description: |- - The "Remove team member" endpoint (described below) is deprecated. + The "Remove team member" endpoint (described below) is closing down. We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. @@ -41089,7 +42332,7 @@ paths: summary: Get team membership for a user (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. Team members will include the members of child teams. @@ -41132,7 +42375,7 @@ paths: summary: Add or update team membership for a user (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -41201,7 +42444,7 @@ paths: summary: Remove team membership for a user (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -41236,7 +42479,7 @@ paths: summary: List team projects (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. Lists the organization projects for a team. tags: @@ -41279,7 +42522,7 @@ paths: summary: Check team permissions for a project (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. tags: @@ -41315,7 +42558,7 @@ paths: summary: Add or update team project permissions (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. tags: @@ -41386,7 +42629,7 @@ paths: summary: Remove a project from a team (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. tags: @@ -41418,7 +42661,7 @@ paths: summary: List team repositories (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. tags: - teams operationId: teams/list-repos-legacy @@ -41459,7 +42702,7 @@ paths: summary: Check team permissions for a repository (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. > [!NOTE] > Repositories inherited through a parent team will also be checked. @@ -41501,7 +42744,7 @@ paths: summary: Add or update team repository permissions (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. @@ -41557,7 +42800,7 @@ paths: summary: Remove a repository from a team (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. tags: @@ -41586,7 +42829,7 @@ paths: summary: List child teams (Legacy) description: |- > [!WARNING] - > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. tags: - teams operationId: teams/list-child-legacy @@ -41647,6 +42890,11 @@ paths: oneOf: - "$ref": "#/components/schemas/private-user" - "$ref": "#/components/schemas/public-user" + discriminator: + propertyName: user_view_type + mapping: + public: "#/components/schemas/public-user" + private: "#/components/schemas/private-user" examples: response-with-public-and-private-profile-information: "$ref": "#/components/examples/private-user-response-with-public-and-private-profile-information" @@ -41964,7 +43212,7 @@ paths: geo: description: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, - which is being deprecated. + which is closing down. type: string enum: - EuropeWest @@ -42023,7 +43271,7 @@ paths: geo: description: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, - which is being deprecated. + which is closing down. type: string enum: - EuropeWest @@ -43293,6 +44541,8 @@ paths: "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -44593,6 +45843,9 @@ paths: List organizations for the authenticated user. For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + + > [!NOTE] + > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. tags: - orgs operationId: orgs/list-for-authenticated-user @@ -44634,7 +45887,7 @@ paths: description: |- Lists packages owned by the authenticated user within the user's namespace. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-authenticated-user @@ -44687,7 +45940,7 @@ paths: description: |- Gets a specific package for a package owned by the authenticated user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-authenticated-user @@ -44717,7 +45970,7 @@ paths: description: |- Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-authenticated-user @@ -44751,7 +46004,7 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-authenticated-user @@ -44787,7 +46040,7 @@ paths: description: |- Lists package versions for a package owned by the authenticated user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-authenticated-user @@ -44838,7 +46091,7 @@ paths: description: |- Gets a specific package version for a package owned by the authenticated user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-authenticated-user @@ -44871,7 +46124,7 @@ paths: The authenticated user must have admin permissions in the organization to use this endpoint. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-authenticated-user @@ -44906,7 +46159,7 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-authenticated-user @@ -46033,6 +47286,11 @@ paths: oneOf: - "$ref": "#/components/schemas/private-user" - "$ref": "#/components/schemas/public-user" + discriminator: + propertyName: user_view_type + mapping: + public: "#/components/schemas/public-user" + private: "#/components/schemas/private-user" examples: default-response: "$ref": "#/components/examples/public-user-default-response" @@ -46111,6 +47369,11 @@ paths: oneOf: - "$ref": "#/components/schemas/private-user" - "$ref": "#/components/schemas/public-user" + discriminator: + propertyName: user_view_type + mapping: + public: "#/components/schemas/public-user" + private: "#/components/schemas/private-user" examples: default-response: "$ref": "#/components/examples/public-user-default-response" @@ -46228,7 +47491,7 @@ paths: get: summary: List events for the authenticated user description: |- - If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). > [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. @@ -46659,7 +47922,7 @@ paths: description: |- Lists all packages in a user's namespace for which the requesting user has access. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-user @@ -46717,7 +47980,7 @@ paths: description: |- Gets a specific package metadata for a public package owned by a user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-user @@ -46750,7 +48013,7 @@ paths: If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-user @@ -46787,7 +48050,7 @@ paths: If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-user @@ -46824,7 +48087,7 @@ paths: description: |- Lists package versions for a public package owned by a specified user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-user @@ -46864,7 +48127,7 @@ paths: description: |- Gets a specific package version for a public package owned by a specified user. - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-user @@ -46898,7 +48161,7 @@ paths: If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-user @@ -46936,7 +48199,7 @@ paths: If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-user @@ -49182,7 +50445,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > Webhook events for Dependabot alerts are currently in beta and subject to change. + > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A Dependabot alert was automatically closed by a Dependabot auto-triage rule. operationId: dependabot-alert/auto-dismissed @@ -49252,7 +50515,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > Webhook events for Dependabot alerts are currently in beta and subject to change. + > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed. @@ -49323,7 +50586,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > Webhook events for Dependabot alerts are currently in beta and subject to change. + > Webhook events for Dependabot alerts are currently in public preview and subject to change. 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. @@ -49394,7 +50657,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > Webhook events for Dependabot alerts are currently in beta and subject to change. + > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A Dependabot alert was manually closed. operationId: dependabot-alert/dismissed externalDocs: @@ -49463,7 +50726,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > Webhook events for Dependabot alerts are currently in beta and subject to change. + > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A manifest file change removed a vulnerability. operationId: dependabot-alert/fixed externalDocs: @@ -49532,7 +50795,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > Webhook events for Dependabot alerts are currently in beta and subject to change. + > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A manifest file change introduced a vulnerable dependency that had previously been fixed. operationId: dependabot-alert/reintroduced @@ -49602,7 +50865,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] - > Webhook events for Dependabot alerts are currently in beta and subject to change. + > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A Dependabot alert was manually reopened. operationId: dependabot-alert/reopened externalDocs: @@ -50188,7 +51451,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A comment on the discussion was marked as the answer. operationId: discussion/answered externalDocs: @@ -50257,7 +51520,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: The category of a discussion was changed. operationId: discussion/category-changed externalDocs: @@ -50326,7 +51589,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was closed. operationId: discussion/closed externalDocs: @@ -50395,7 +51658,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A comment on a discussion was created. operationId: discussion-comment/created externalDocs: @@ -50464,7 +51727,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A comment on a discussion was deleted. operationId: discussion-comment/deleted externalDocs: @@ -50533,7 +51796,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A comment on a discussion was edited. operationId: discussion-comment/edited externalDocs: @@ -50602,7 +51865,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was created. operationId: discussion/created externalDocs: @@ -50671,7 +51934,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was deleted. operationId: discussion/deleted externalDocs: @@ -50740,7 +52003,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: The title or body on a discussion was edited, or the category of the discussion was changed. operationId: discussion/edited @@ -50810,7 +52073,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A label was added to a discussion. operationId: discussion/labeled externalDocs: @@ -50879,7 +52142,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was locked. operationId: discussion/locked externalDocs: @@ -50948,7 +52211,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was pinned. operationId: discussion/pinned externalDocs: @@ -51017,7 +52280,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was reopened. operationId: discussion/reopened externalDocs: @@ -51086,7 +52349,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was transferred to another repository. operationId: discussion/transferred externalDocs: @@ -51155,7 +52418,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A comment on the discussion was unmarked as the answer. operationId: discussion/unanswered externalDocs: @@ -51224,7 +52487,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A label was removed from a discussion. operationId: discussion/unlabeled externalDocs: @@ -51293,7 +52556,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was unlocked. operationId: discussion/unlocked externalDocs: @@ -51362,7 +52625,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] - > Webhook events for GitHub Discussions are currently in beta and subject to change. + > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was unpinned. operationId: discussion/unpinned externalDocs: @@ -55415,7 +56678,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. > [!NOTE] - > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was approved. operationId: personal-access-token-request/approved externalDocs: @@ -55480,7 +56743,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. > [!NOTE] - > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was cancelled by the requester. operationId: personal-access-token-request/cancelled @@ -55546,7 +56809,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. > [!NOTE] - > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was created. operationId: personal-access-token-request/created externalDocs: @@ -55611,7 +56874,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. > [!NOTE] - > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was denied. operationId: personal-access-token-request/denied externalDocs: @@ -56704,7 +57967,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was closed. operationId: projects-v2/closed externalDocs: @@ -56772,7 +58035,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was created. operationId: projects-v2/created externalDocs: @@ -56840,7 +58103,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was deleted. operationId: projects-v2/deleted externalDocs: @@ -56908,7 +58171,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: The title, description, or README of a project in the organization was changed. operationId: projects-v2/edited @@ -56977,7 +58240,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). 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)." operationId: projects-v2-item/archived @@ -57046,7 +58309,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A draft issue in an organization project was converted to an issue. operationId: projects-v2-item/converted externalDocs: @@ -57114,7 +58377,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: An item was added to a project in the organization. operationId: projects-v2-item/created externalDocs: @@ -57182,7 +58445,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: An item was deleted from a project in the organization. operationId: projects-v2-item/deleted externalDocs: @@ -57250,7 +58513,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). 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. @@ -57320,7 +58583,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). 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. @@ -57390,7 +58653,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). 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)." operationId: projects-v2-item/restored @@ -57459,7 +58722,7 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was reopened. operationId: projects-v2/reopened externalDocs: @@ -61410,7 +62673,7 @@ x-webhooks: This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] - > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. + > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. description: A repository vulnerability alert was created. operationId: repository-vulnerability-alert/create externalDocs: @@ -61474,7 +62737,7 @@ x-webhooks: This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] - > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. + > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. description: A repository vulnerability alert was dismissed. operationId: repository-vulnerability-alert/dismiss externalDocs: @@ -61538,7 +62801,7 @@ x-webhooks: This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] - > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. + > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. description: A previously dismissed or resolved repository vulnerability alert was reopened. operationId: repository-vulnerability-alert/reopen @@ -61603,7 +62866,7 @@ x-webhooks: This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] - > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. + > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. description: A repository vulnerability alert was marked as resolved. operationId: repository-vulnerability-alert/resolve externalDocs: @@ -61806,7 +63069,7 @@ x-webhooks: - repository - organization - app - secret-scanning-alert-reopened: + secret-scanning-alert-publicly-leaked: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -61814,8 +63077,8 @@ x-webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A previously closed secret scanning alert was reopened. - operationId: secret-scanning-alert/reopened + description: A secret scanning alert was detected in a public repo. + operationId: secret-scanning-alert/publicly-leaked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -61859,7 +63122,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -61872,7 +63135,7 @@ x-webhooks: - repository - organization - app - secret-scanning-alert-resolved: + secret-scanning-alert-reopened: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -61880,8 +63143,8 @@ x-webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was closed. - operationId: secret-scanning-alert/resolved + description: A previously closed secret scanning alert was reopened. + operationId: secret-scanning-alert/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -61925,7 +63188,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -61938,7 +63201,7 @@ x-webhooks: - repository - organization - app - secret-scanning-alert-validated: + secret-scanning-alert-resolved: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -61946,8 +63209,8 @@ x-webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was validated. - operationId: secret-scanning-alert/validated + description: A secret scanning alert was closed. + operationId: secret-scanning-alert/resolved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -61991,7 +63254,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62004,16 +63267,18 @@ x-webhooks: - repository - organization - app - security-advisory-published: + secret-scanning-alert-validated: post: summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A security advisory was published to the GitHub community. - operationId: security-advisory/published + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was validated. + operationId: secret-scanning-alert/validated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -62055,7 +63320,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62063,17 +63328,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: secret_scanning_alert supported-webhook-types: + - repository + - organization - app - security-advisory-updated: + security-advisory-published: post: summary: |- This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: The metadata or description of a security advisory was changed. - operationId: security-advisory/updated + description: A security advisory was published to the GitHub community. + operationId: security-advisory/published externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: @@ -62117,7 +63384,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-security-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62128,14 +63395,14 @@ x-webhooks: subcategory: security_advisory supported-webhook-types: - app - security-advisory-withdrawn: + security-advisory-updated: post: summary: |- This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A previously published security advisory was withdrawn. - operationId: security-advisory/withdrawn + description: The metadata or description of a security advisory was changed. + operationId: security-advisory/updated externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: @@ -62179,7 +63446,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62190,15 +63457,16 @@ x-webhooks: subcategory: security_advisory supported-webhook-types: - app - security-and-analysis: + security-advisory-withdrawn: post: summary: |- - This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - operationId: security-and-analysis + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + description: A previously published security advisory was withdrawn. + operationId: security-advisory/withdrawn externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -62240,7 +63508,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62248,151 +63516,18 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_and_analysis + subcategory: security_advisory supported-webhook-types: - - repository - - organization - app - sponsorship-cancelled: - post: - summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsorship was cancelled and the last billing cycle has ended. - - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/cancelled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sponsorship - supported-webhook-types: - - sponsors_listing - sponsorship-created: - post: - summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor created a sponsorship for a sponsored account. This event - occurs once the payment is successfully processed. - operationId: sponsorship/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-sponsorship-created" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sponsorship - supported-webhook-types: - - sponsors_listing - sponsorship-edited: + security-and-analysis: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - 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. - operationId: sponsorship/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + operationId: security-and-analysis externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis parameters: - name: User-Agent in: header @@ -62434,7 +63569,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-security-and-analysis" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62442,20 +63577,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: security_and_analysis supported-webhook-types: - - sponsors_listing - sponsorship-pending-cancellation: + - repository + - organization + - app + sponsorship-cancelled: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: |- - A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. + A sponsorship was cancelled and the last billing cycle has ended. This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/pending-cancellation + operationId: sponsorship/cancelled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -62499,7 +63636,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62510,15 +63647,15 @@ x-webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-pending-tier-change: + sponsorship-created: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor scheduled a downgrade to a lower sponsorship tier. The - new tier will become effective on their next billing date. - operationId: sponsorship/pending-tier-change + description: A sponsor created a sponsorship for a sponsored account. This event + occurs once the payment is successfully processed. + operationId: sponsorship/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -62562,7 +63699,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62573,17 +63710,16 @@ x-webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-tier-changed: + sponsorship-edited: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - 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. - operationId: sponsorship/tier-changed + 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. + operationId: sponsorship/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -62627,7 +63763,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62638,16 +63774,19 @@ x-webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - star-created: + sponsorship-pending-cancellation: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone starred a repository. - operationId: star/created + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: |- + A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. + + This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. + operationId: sponsorship/pending-cancellation externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -62689,7 +63828,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62697,21 +63836,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - star-deleted: + - sponsors_listing + sponsorship-pending-tier-change: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone unstarred the repository. - operationId: star/deleted + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: A sponsor scheduled a downgrade to a lower sponsorship tier. The + new tier will become effective on their next billing date. + operationId: sponsorship/pending-tier-change externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -62753,7 +63891,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62761,20 +63899,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - status: + - sponsors_listing + sponsorship-tier-changed: post: summary: |- - This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. - operationId: status + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + 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. + operationId: sponsorship/tier-changed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#status + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -62816,7 +63956,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62824,23 +63964,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: status + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - sub-issues-parent-issue-added: + - sponsors_listing + star-created: post: summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A parent issue was added to an issue. - operationId: sub-issues/parent-issue-added + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone starred a repository. + operationId: star/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -62882,7 +64018,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-star-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62890,23 +64026,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: star supported-webhook-types: - repository - organization - app - sub-issues-parent-issue-removed: + star-deleted: post: summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A parent issue was removed from an issue. - operationId: sub-issues/parent-issue-removed + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone unstarred the repository. + operationId: star/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -62948,7 +64082,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-star-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62956,23 +64090,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: star supported-webhook-types: - repository - organization - app - sub-issues-sub-issue-added: + status: post: summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. + This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A sub-issue was added to an issue. - operationId: sub-issues/sub-issue-added + To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. + operationId: status externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#status parameters: - name: User-Agent in: header @@ -63014,7 +64145,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-status" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63022,12 +64153,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: status supported-webhook-types: - repository - organization - app - sub-issues-sub-issue-removed: + sub-issues-parent-issue-added: post: summary: |- This event occurs when there is activity relating to sub-issues. @@ -63035,8 +64166,8 @@ x-webhooks: For activity relating to issues more generally, use the `issues` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A sub-issue was removed from an issue. - operationId: sub-issues/sub-issue-removed + description: A parent issue was added to an issue. + operationId: sub-issues/parent-issue-added externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: @@ -63080,7 +64211,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63093,18 +64224,18 @@ x-webhooks: - repository - organization - app - team-add: + sub-issues-parent-issue-removed: post: summary: |- - This event occurs when a team is added to a repository. - For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + This event occurs when there is activity relating to sub-issues. - For activity relating to teams, see the `teams` event. + For activity relating to issues more generally, use the `issues` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - operationId: team-add + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A parent issue was removed from an issue. + operationId: sub-issues/parent-issue-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -63146,7 +64277,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63154,22 +64285,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team_add + subcategory: sub-issues supported-webhook-types: - repository - organization - app - team-added-to-repository: + sub-issues-sub-issue-added: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when there is activity relating to sub-issues. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was granted access to a repository. - operationId: team/added-to-repository + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A sub-issue was added to an issue. + operationId: sub-issues/sub-issue-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -63211,7 +64343,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63219,22 +64351,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sub-issues supported-webhook-types: + - repository - organization - - business - app - team-created: + sub-issues-sub-issue-removed: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when there is activity relating to sub-issues. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was created. - operationId: team/created + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A sub-issue was removed from an issue. + operationId: sub-issues/sub-issue-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -63276,7 +64409,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63284,22 +64417,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sub-issues supported-webhook-types: + - repository - organization - - business - app - team-deleted: + team-add: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when a team is added to a repository. + For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + + For activity relating to teams, see the `teams` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was deleted. - operationId: team/deleted + operationId: team-add externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add parameters: - name: User-Agent in: header @@ -63341,7 +64475,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-add" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63349,20 +64483,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: team_add supported-webhook-types: + - repository - organization - - business - app - team-edited: + team-added-to-repository: post: summary: |- This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: The name, description, or visibility of a team was changed. - operationId: team/edited + description: A team was granted access to a repository. + operationId: team/added-to-repository externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: @@ -63406,7 +64540,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-team-added-to-repository" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63419,15 +64553,15 @@ x-webhooks: - organization - business - app - team-removed-from-repository: + team-created: post: summary: |- This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team's access to a repository was removed. - operationId: team/removed-from-repository + description: A team was created. + operationId: team/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: @@ -63471,7 +64605,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-team-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63484,16 +64618,17 @@ x-webhooks: - organization - business - app - watch-started: + team-deleted: post: summary: |- - This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/rest/activity/watching)" in the REST API documentation. + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone started watching the repository. - operationId: watch/started + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team was deleted. + operationId: team/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#watch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -63535,7 +64670,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-team-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63543,22 +64678,216 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: watch + subcategory: team supported-webhook-types: - - repository - organization + - business - app - workflow-dispatch: + team-edited: post: summary: |- - This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow)." - - For activity relating to workflow runs, use the `workflow_run` event. + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: workflow-dispatch + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: The name, description, or visibility of a team was changed. + operationId: team/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-team-edited" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: team + supported-webhook-types: + - organization + - business + - app + team-removed-from-repository: + post: + summary: |- + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team's access to a repository was removed. + operationId: team/removed-from-repository + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-team-removed-from-repository" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: team + supported-webhook-types: + - organization + - business + - app + watch-started: + post: + summary: |- + This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/rest/activity/watching)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone started watching the repository. + operationId: watch/started + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#watch + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-watch-started" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: watch + supported-webhook-types: + - repository + - organization + - app + workflow-dispatch: + post: + summary: |- + This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow)." + + For activity relating to workflow runs, use the `workflow_run` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + operationId: workflow-dispatch + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch parameters: - name: User-Agent in: header @@ -64393,6 +65722,9 @@ components: starred_at: type: string example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public required: - avatar_url - events_url @@ -64739,6 +66071,9 @@ components: starred_at: type: string example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public required: - avatar_url - events_url @@ -65434,7 +66769,8 @@ components: type: string description: The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot - Business subscription. This property is in beta and is subject to change. + Business subscription. This property is in public preview and is subject + to change. enum: - write organization_announcement_banners: @@ -65481,7 +66817,7 @@ components: organization_projects: type: string description: The level of permission to grant the access token to manage - organization projects and projects beta (where available). + organization projects and projects public preview (where available). enum: - read - write @@ -66032,7 +67368,7 @@ components: use_squash_pr_title_as_default: type: boolean description: Whether a squash merge commit can use the pull request title - as default. **This property has been deprecated. Please use `squash_merge_commit_title` + as default. **This property is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true @@ -66851,7 +68187,7 @@ components: - html_url - key - name - organization-simple: + nullable-organization-simple: title: Organization Simple description: A GitHub organization. type: object @@ -66909,6 +68245,7 @@ components: - public_members_url - avatar_url - description + nullable: true nullable-team-simple: title: Team Simple description: Groups of organization members that gives permissions on specified @@ -67066,8 +68403,8 @@ components: example: disabled | all group_id: nullable: true - type: integer - example: 1 + type: string + example: 62ab9291-fae2-468e-974b-7e45096d5021 html_url: type: string format: uri @@ -67097,17 +68434,9 @@ components: type: object properties: assignee: - type: object - description: The assignee that has been granted access to GitHub Copilot. - additionalProperties: true - oneOf: - - "$ref": "#/components/schemas/simple-user" + "$ref": "#/components/schemas/simple-user" organization: - type: object - description: The organization to which this seat belongs. - nullable: true - oneOf: - - "$ref": "#/components/schemas/organization-simple" + "$ref": "#/components/schemas/nullable-organization-simple" assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. @@ -67144,10 +68473,299 @@ components: format: date-time description: Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + plan_type: + type: string + description: The Copilot plan of the organization, or the parent enterprise, + when applicable. + enum: + - business + - enterprise + - unknown required: - assignee - created_at additionalProperties: false + copilot-ide-code-completions: + type: object + description: Usage metrics for Copilot editor code completions in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code suggestion, + across all active editors. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the given editor for + Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given language. Includes both full + and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given editor. Includes both full and + partial acceptances. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + nullable: true + description: The training date for the custom model. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code completion suggestion for the given editor, for the given + language and model. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages, for + the given editor. + items: + type: object + description: Usage metrics for a given language for the given + editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code + completion suggestions, for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one + Copilot code completion suggestion for the given editor, + for the given language. Includes both full and partial + acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code suggestions generated + for the given editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code suggestions accepted + for the given editor, for the given language. Includes + both full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code suggested by + Copilot code completions for the given editor, for the + given language. + total_code_lines_accepted: + type: integer + description: The number of lines of code accepted from + Copilot code suggestions for the given editor, for the + given language. + copilot-ide-chat: + type: object + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in the + specified editor. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + nullable: true + description: The training date for the custom model. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in + the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated by users in + the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted a code suggestion + from Copilot Chat using the 'Insert Code' UI element, for + the given editor. + total_chat_copy_events: + type: integer + description: The number of times users copied a code suggestion + from Copilot Chat using the keyboard, or the 'Copy' UI element, + for the given editor. + copilot-dotcom-chat: + type: object + description: Usage metrics for Copilot Chat in github.com + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once. + models: + type: array + description: List of model metrics for a custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + description: The training date for the custom model (if applicable). + nullable: true + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users on github.com. + copilot-dotcom-pull-requests: + type: object + description: Usage metrics for Copilot for pull requests. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull Requests on github.com + to generate a pull request summary at least once. + repositories: + type: array + description: Repositories in which users used Copilot for Pull Requests + to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull request summaries + using Copilot for Pull Requests in the given repository. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + nullable: true + description: The training date for the custom model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries generated + using Copilot for Pull Requests in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated pull request + summaries using Copilot for Pull Requests in the given repository + and model. + copilot-usage-metrics-day: + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` + format. + total_active_users: + type: integer + description: The total number of Copilot users with activity belonging to + any Copilot feature, globally, for the given day. Includes passive activity + such as receiving a code suggestion, as well as engagement activity such + as accepting a code suggestion or prompting chat. Does not include authentication + events. Is not limited to the individual features detailed on the endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with any Copilot + feature, for the given day. Examples include but are not limited to accepting + a code suggestion, prompting Copilot chat, or triggering a PR Summary. + Does not include authentication events. Is not limited to the individual + features detailed on the endpoint. + copilot_ide_code_completions: + "$ref": "#/components/schemas/copilot-ide-code-completions" + copilot_ide_chat: + "$ref": "#/components/schemas/copilot-ide-chat" + copilot_dotcom_chat: + "$ref": "#/components/schemas/copilot-dotcom-chat" + copilot_dotcom_pull_requests: + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + required: + - date + additionalProperties: true copilot-usage-metrics: title: Copilot Usage Metrics description: Summary of Copilot usage. @@ -67939,6 +69557,15 @@ components: - active - inactive - unknown + publicly_leaked: + type: boolean + description: Whether the secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: Whether the detected secret was found in multiple repositories + in the same organization or enterprise. + nullable: true actor: title: Actor description: Actor @@ -68645,6 +70272,11 @@ components: type: string size: type: integer + encoding: + type: string + description: The encoding used for `content`. Currently, `"utf-8"` + and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -68700,6 +70332,8 @@ components: id: type: integer format: int64 + user_view_type: + type: string node_id: type: string avatar_url: @@ -68800,10 +70434,6 @@ components: - name - space - private_repos - suspended_at: - type: string - format: date-time - nullable: true private_gists: type: integer example: 1 @@ -69031,6 +70661,11 @@ components: type: boolean content: type: string + encoding: + type: string + description: The encoding used for `content`. Currently, `"utf-8"` + and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -69617,6 +71252,14 @@ components: enum: - enabled - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled minimal-repository: title: Minimal Repository description: Minimal Repository @@ -70032,6 +71675,64 @@ components: - reason - url - subscribed + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description organization-full: title: Organization Full description: Organization Full @@ -70144,6 +71845,10 @@ components: type: integer example: 8 nullable: true + description: |- + The number of collaborators on private repositories. + + This field may be null if the number of private repositories is over 50,000. billing_email: type: string format: email @@ -70209,7 +71914,7 @@ components: type: boolean example: false description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. @@ -70219,7 +71924,7 @@ components: type: boolean example: false description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. @@ -70229,7 +71934,7 @@ components: type: boolean example: false description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. @@ -70239,7 +71944,7 @@ components: type: boolean example: false description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. @@ -70249,7 +71954,7 @@ components: type: boolean example: false description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. @@ -70259,7 +71964,7 @@ components: type: boolean example: false description: |- - **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. @@ -70287,6 +71992,11 @@ components: type: string format: date-time nullable: true + deploy_keys_enabled_for_repositories: + type: boolean + example: false + description: Controls whether or not deploy keys may be added and used for + repositories in the organization. required: - login - url @@ -70451,6 +72161,59 @@ components: "$ref": "#/components/schemas/actions-default-workflow-permissions" can_approve_pull_request_reviews: "$ref": "#/components/schemas/actions-can-approve-pull-request-reviews" + runner-groups-org: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_repositories_url: + description: Link to the selected repositories resource for this runner + group. Not present unless visibility was set to `selected` + type: string + runners_url: + type: string + hosted_runners_url: + type: string + inherited: + type: boolean + inherited_allows_public_repositories: + type: boolean + allows_public_repositories: + type: boolean + workflow_restrictions_read_only: + description: If `true`, the `restricted_to_workflows` and `selected_workflows` + fields cannot be modified. + type: boolean + default: false + restricted_to_workflows: + description: If `true`, the runner group will be restricted to running only + the workflows specified in the `selected_workflows` array. + type: boolean + default: false + selected_workflows: + description: List of workflows the runner group should be allowed to run. + This setting will be ignored unless `restricted_to_workflows` is set to + `true`. + type: array + items: + type: string + description: Name of workflow the runner group should be allowed to run. + Note that a ref, tag, or long SHA is required. + example: octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - id + - name + - visibility + - default + - runners_url + - inherited + - allows_public_repositories runner-label: title: Self hosted runner label description: A label for a self hosted runner @@ -70707,6 +72470,7 @@ components: code-scanning-alert-state: type: string description: State of a code scanning alert. + nullable: true enum: - open - dismissed @@ -70927,6 +72691,7 @@ components: enum: - global - organization + - enterprise description: type: string description: A description of the code security configuration @@ -70993,6 +72758,35 @@ components: - enabled - disabled - not_set + secret_scanning_delegated_bypass: + type: string + description: The enablement status of secret scanning delegated bypass + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass_options: + type: object + description: Feature options for secret scanning delegated bypass + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE secret_scanning_validity_checks: type: string description: The enablement status of secret scanning validity checks @@ -71436,9 +73230,9 @@ components: description: The number of seats that have not used Copilot during the current billing cycle. copilot-organization-details: - title: Copilot Business Organization Details + title: Copilot Organization Details description: Information about the seat breakdown and policies set for an organization - with a Copilot Business subscription. + with a Copilot Business or Copilot Enterprise subscription. type: object properties: seat_breakdown: @@ -71484,6 +73278,14 @@ components: - assign_selected - disabled - unconfigured + plan_type: + type: string + description: The Copilot plan of the organization, or the parent enterprise, + when applicable. + enum: + - business + - enterprise + - unknown required: - seat_breakdown - public_code_suggestions @@ -72042,6 +73844,116 @@ components: - ping_url - created_at - updated_at + api-insights-route-stats: + title: Route Stats + description: API Insights usage route stats for an actor + type: array + items: + type: object + properties: + http_method: + description: The HTTP method + type: string + api_route: + description: The API path's route template + type: string + total_request_count: + description: The total number of requests within the queried time period + type: integer + format: int64 + rate_limited_request_count: + description: The total number of requests that were rate limited within + the queried time period + type: integer + format: int64 + last_rate_limited_timestamp: + type: string + nullable: true + last_request_timestamp: + type: string + api-insights-subject-stats: + title: Subject Stats + description: API Insights usage subject stats for an organization + type: array + items: + type: object + properties: + subject_type: + type: string + subject_name: + type: string + subject_id: + type: integer + format: int64 + total_request_count: + type: integer + rate_limited_request_count: + type: integer + last_rate_limited_timestamp: + type: string + nullable: true + last_request_timestamp: + type: string + api-insights-summary-stats: + title: Summary Stats + description: API Insights usage summary stats for an organization + type: object + properties: + total_request_count: + description: The total number of requests within the queried time period + type: integer + format: int64 + rate_limited_request_count: + description: The total number of requests that were rate limited within + the queried time period + type: integer + format: int64 + api-insights-time-stats: + title: Time Stats + description: API Insights usage time stats for an organization + type: array + items: + type: object + properties: + timestamp: + type: string + total_request_count: + type: integer + format: int64 + rate_limited_request_count: + type: integer + format: int64 + api-insights-user-stats: + title: User Stats + description: API Insights usage stats for a user + type: array + items: + type: object + properties: + actor_type: + type: string + actor_name: + type: string + actor_id: + type: integer + format: int64 + integration_id: + type: integer + format: int64 + nullable: true + oauth_application_id: + type: integer + format: int64 + nullable: true + total_request_count: + type: integer + rate_limited_request_count: + type: integer + last_rate_limited_timestamp: + type: string + nullable: true + last_request_timestamp: + type: string interaction-group: type: string description: The type of GitHub user that can comment, open issues, or create @@ -72468,6 +74380,9 @@ components: starred_at: type: string example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public required: - avatar_url - events_url @@ -72616,6 +74531,15 @@ components: created_at: type: string description: Date and time when the request for access was created. + token_id: + type: integer + description: Unique identifier of the user's token. This field can also + be found in audit log events and the organization's settings for their + PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -72638,6 +74562,8 @@ components: - repositories_url - permissions - created_at + - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -72649,9 +74575,9 @@ components: properties: id: type: integer - description: Unique identifier of the fine-grained personal access token. - The `pat_id` used to get details about an approved fine-grained personal - access token. + description: Unique identifier of the fine-grained personal access token + grant. The `pat_id` used to get details about an approved fine-grained + personal access token. owner: "$ref": "#/components/schemas/simple-user" repository_selection: @@ -72685,6 +74611,15 @@ components: type: string description: Date and time when the fine-grained personal access token was approved to access the organization. + token_id: + type: integer + description: Unique identifier of the user's token. This field can also + be found in audit log events and the organization's settings for their + PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -72706,6 +74641,8 @@ components: - repositories_url - permissions - access_granted_at + - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -73215,7 +75152,7 @@ components: use_squash_pr_title_as_default: type: boolean description: Whether a squash merge commit can use the pull request title - as default. **This property has been deprecated. Please use `squash_merge_commit_title` + as default. **This property is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true @@ -73864,7 +75801,6 @@ components: description: An actor that can bypass rules in a ruleset required: - actor_type - - bypass_mode properties: actor_id: type: integer @@ -73886,10 +75822,12 @@ components: type: string description: When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` - is not applicable for the `DeployKey` actor type. + is not applicable for the `DeployKey` actor type. Also, `pull_request` + is only applicable to branch rulesets. enum: - always - pull_request + default: always repository-ruleset-conditions: title: Repository ruleset conditions for ref names type: object @@ -74001,9 +75939,10 @@ components: org-ruleset-conditions: title: Organization ruleset conditions type: object - description: Conditions for an organization ruleset. The conditions object should - contain both `repository_name` and `ref_name` properties or both `repository_id` - and `ref_name` properties. + description: |- + Conditions for an organization ruleset. + The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + The push rulesets conditions object does not require the `ref_name` property. oneOf: - type: object title: repository_name_and_ref_name @@ -74181,6 +76120,31 @@ components: type: string enum: - required_signatures + repository-rule-params-required-reviewer-configuration: + title: RequiredReviewerConfiguration + description: A reviewing team, and file patterns describing which files they + must approve changes to. + type: object + properties: + file_patterns: + type: array + description: Array of file patterns. Pull requests which change matching + files must be approved by the specified team. File patterns use the same + syntax as `.gitignore` files. + items: + type: string + minimum_approvals: + type: integer + description: Minimum number of approvals required from the specified team. + If set to zero, the team will be added to the pull request but approval + is optional. + reviewer_id: + type: string + description: Node ID of the team which must review changes to matching files. + required: + - file_patterns + - minimum_approvals + - reviewer_id repository-rule-pull-request: title: pull_request description: Require all commits be made to a non-target branch and submitted @@ -74739,6 +76703,7 @@ components: description: The URL of the ruleset html: type: object + nullable: true properties: href: type: string @@ -77871,6 +79836,8 @@ components: type: string site_admin: type: boolean + user_view_type: + type: string teams: type: array items: @@ -77975,6 +79942,9 @@ components: site_admin: type: boolean example: false + user_view_type: + type: string + example: public name: type: string client_id: @@ -78893,6 +80863,7 @@ components: id: type: integer example: 5 + format: int64 node_id: type: string example: MDEwOkNoZWNrU3VpdGU1 @@ -79930,6 +81901,9 @@ components: role_name: type: string example: admin + user_view_type: + type: string + example: public required: - avatar_url - events_url @@ -80096,6 +82070,9 @@ components: role_name: type: string example: admin + user_view_type: + type: string + example: public required: - avatar_url - events_url @@ -80789,6 +82766,8 @@ components: type: string sha: type: string + content: + type: string url: type: string format: uri @@ -80817,8 +82796,6 @@ components: type: string path: type: string - content: - type: string sha: type: string url: @@ -80894,8 +82871,6 @@ components: - size - type - url - - content - - encoding content-directory: title: Content Directory description: A list of directory items @@ -81352,6 +83327,8 @@ components: type: string name: type: string + user_view_type: + type: string required: - contributions - type @@ -81556,6 +83533,11 @@ components: example: SPDX-2.3 description: The version of the SPDX specification that this document conforms to. + comment: + type: string + example: 'Exact versions could not be resolved for some packages. For + more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/' + description: An optional comment about the SPDX document. creationInfo: type: object properties: @@ -81580,15 +83562,9 @@ components: type: string example: CC0-1.0 description: The license under which the SPDX document is licensed. - documentDescribes: - type: array - items: - type: string - example: github/github - description: The name of the repository that the SPDX document describes. documentNamespace: type: string - example: https://github.com/example/dependency_graph/sbom-123 + example: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 description: The namespace for the SPDX document. packages: type: array @@ -81601,7 +83577,7 @@ components: description: A unique SPDX identifier for the package. name: type: string - example: rubygems:github/github + example: github/github description: The name of the package. versionInfo: type: string @@ -81672,14 +83648,33 @@ components: - versionInfo - downloadLocation - filesAnalyzed - - supplier + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + example: DEPENDS_ON + description: The type of relationship between the two SPDX elements. + spdxElementId: + type: string + description: The SPDX identifier of the package that is the source + of the relationship. + relatedSpdxElement: + type: string + description: The SPDX identifier of the package that is the target + of the relationship. + required: + - relationshipType + - spdxElementId + - relatedSpdxElement required: - SPDXID - spdxVersion - creationInfo - name - dataLicense - - documentDescribes - documentNamespace - packages required: @@ -81890,7 +83885,7 @@ components: type: string example: production target_url: - description: 'Deprecated: the URL to associate with this status.' + description: 'Closing down notice: the URL to associate with this status.' default: '' type: string format: uri @@ -84195,12 +86190,12 @@ components: type: string position: description: The line index in the diff to which the comment applies. This - field is deprecated; use `line` instead. + field is closing down; use `line` instead. example: 1 type: integer original_position: description: The index of the original line in the diff to which the comment - applies. This field is deprecated; use `original_line` instead. + applies. This field is closing down; use `original_line` instead. example: 4 type: integer commit_id: @@ -84537,6 +86532,8 @@ components: last_used: type: string nullable: true + enabled: + type: boolean required: - id - key @@ -85269,453 +87266,11 @@ components: ref: type: string repo: - type: object - nullable: true - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - node_id: - type: string - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - name: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - format: uri - events_url: - type: string - followers_url: - type: string - format: uri - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - nullable: true - html_url: - type: string - format: uri - id: - type: integer - node_id: - type: string - login: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - format: uri - type: - type: string - url: - type: string - format: uri - required: - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - format: uri - statuses_url: - type: string - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - url: - type: string - format: uri - clone_url: - type: string - default_branch: - type: string - forks: - type: integer - forks_count: - type: integer - git_url: - type: string - has_downloads: - type: boolean - has_issues: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - has_pages: - type: boolean - has_discussions: - type: boolean - homepage: - type: string - format: uri - nullable: true - language: - type: string - nullable: true - master_branch: - type: string - archived: - type: boolean - disabled: - type: boolean - visibility: - description: 'The repository visibility: public, private, or internal.' - type: string - mirror_url: - type: string - format: uri - nullable: true - open_issues: - type: integer - open_issues_count: - type: integer - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - push: - type: boolean - triage: - type: boolean - pull: - type: boolean - required: - - admin - - pull - - push - temp_clone_token: - type: string - allow_merge_commit: - type: boolean - allow_squash_merge: - type: boolean - allow_rebase_merge: - type: boolean - license: - type: object - properties: - key: - type: string - name: - type: string - url: - type: string - format: uri - nullable: true - spdx_id: - type: string - nullable: true - node_id: - type: string - required: - - key - - name - - url - - spdx_id - - node_id - nullable: true - pushed_at: - type: string - format: date-time - size: - type: integer - ssh_url: - type: string - stargazers_count: - type: integer - svn_url: - type: string - format: uri - topics: - type: array - items: - type: string - watchers: - type: integer - watchers_count: - type: integer - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - allow_forking: - type: boolean - is_template: - type: boolean - web_commit_signoff_required: - type: boolean - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - - clone_url - - default_branch - - forks - - forks_count - - git_url - - has_downloads - - has_issues - - has_projects - - has_wiki - - has_pages - - has_discussions - - homepage - - language - - archived - - disabled - - mirror_url - - open_issues - - open_issues_count - - license - - pushed_at - - size - - ssh_url - - stargazers_count - - svn_url - - watchers - - watchers_count - - created_at - - updated_at + "$ref": "#/components/schemas/repository" sha: type: string user: - type: object - properties: - avatar_url: - type: string - format: uri - events_url: - type: string - followers_url: - type: string - format: uri - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - nullable: true - html_url: - type: string - format: uri - id: - type: integer - format: int64 - node_id: - type: string - login: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - format: uri - type: - type: string - url: - type: string - format: uri - required: - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url + "$ref": "#/components/schemas/simple-user" required: - label - ref @@ -85730,431 +87285,11 @@ components: ref: type: string repo: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - is_template: - type: boolean - node_id: - type: string - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - name: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - format: uri - events_url: - type: string - followers_url: - type: string - format: uri - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - nullable: true - html_url: - type: string - format: uri - id: - type: integer - node_id: - type: string - login: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - format: uri - type: - type: string - url: - type: string - format: uri - required: - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - format: uri - statuses_url: - type: string - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - url: - type: string - format: uri - clone_url: - type: string - default_branch: - type: string - forks: - type: integer - forks_count: - type: integer - git_url: - type: string - has_downloads: - type: boolean - has_issues: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - has_pages: - type: boolean - has_discussions: - type: boolean - homepage: - type: string - format: uri - nullable: true - language: - type: string - nullable: true - master_branch: - type: string - archived: - type: boolean - disabled: - type: boolean - visibility: - description: 'The repository visibility: public, private, or internal.' - type: string - mirror_url: - type: string - format: uri - nullable: true - open_issues: - type: integer - open_issues_count: - type: integer - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - push: - type: boolean - triage: - type: boolean - pull: - type: boolean - required: - - admin - - pull - - push - temp_clone_token: - type: string - allow_merge_commit: - type: boolean - allow_squash_merge: - type: boolean - allow_rebase_merge: - type: boolean - license: - "$ref": "#/components/schemas/nullable-license-simple" - pushed_at: - type: string - format: date-time - size: - type: integer - ssh_url: - type: string - stargazers_count: - type: integer - svn_url: - type: string - format: uri - topics: - type: array - items: - type: string - watchers: - type: integer - watchers_count: - type: integer - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - allow_forking: - type: boolean - web_commit_signoff_required: - type: boolean - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - - clone_url - - default_branch - - forks - - forks_count - - git_url - - has_downloads - - has_issues - - has_projects - - has_wiki - - has_pages - - has_discussions - - homepage - - language - - archived - - disabled - - mirror_url - - open_issues - - open_issues_count - - license - - pushed_at - - size - - ssh_url - - stargazers_count - - svn_url - - watchers - - watchers_count - - created_at - - updated_at + "$ref": "#/components/schemas/repository" sha: type: string user: - type: object - properties: - avatar_url: - type: string - format: uri - events_url: - type: string - followers_url: - type: string - format: uri - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - nullable: true - html_url: - type: string - format: uri - id: - type: integer - format: int64 - node_id: - type: string - login: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - format: uri - type: - type: string - url: - type: string - format: uri - required: - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url + "$ref": "#/components/schemas/simple-user" required: - label - ref @@ -86826,6 +87961,15 @@ components: - active - inactive - unknown + publicly_leaked: + type: boolean + description: Whether the detected secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: Whether the detected secret was found in multiple repositories + under the same organization or enterprise. + nullable: true secret-scanning-alert-resolution-comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -88557,6 +89701,8 @@ components: type: string format: date-time nullable: true + user_view_type: + type: string required: - avatar_url - events_url @@ -88589,6 +89735,8 @@ components: type: integer format: int64 example: 1 + user_view_type: + type: string node_id: type: string example: MDQ6VXNlcjE= @@ -88736,10 +89884,6 @@ components: - name - space - private_repos - suspended_at: - type: string - format: date-time - nullable: true business_plus: type: boolean ldap_dn: @@ -90225,7 +91369,7 @@ components: use_squash_pr_title_as_default: type: boolean description: Whether a squash merge commit can use the pull request title - as default. **This property has been deprecated. Please use `squash_merge_commit_title` + as default. **This property is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true @@ -90375,102 +91519,6 @@ components: - watchers_count - created_at - updated_at - simple-user-webhooks: - title: Simple User - description: The GitHub user that triggered the event. This property is included - in every webhook payload. - type: object - properties: - name: - nullable: true - type: string - email: - nullable: true - type: string - login: - type: string - example: octocat - id: - type: integer - example: 1 - node_id: - type: string - example: MDQ6VXNlcjE= - avatar_url: - type: string - format: uri - example: https://github.com/images/error/octocat_happy.gif - gravatar_id: - type: string - example: 41d064eb2195891e12d0413f63227ea7 - nullable: true - url: - type: string - format: uri - example: https://api.github.com/users/octocat - html_url: - type: string - format: uri - example: https://github.com/octocat - followers_url: - type: string - format: uri - example: https://api.github.com/users/octocat/followers - following_url: - type: string - example: https://api.github.com/users/octocat/following{/other_user} - gists_url: - type: string - example: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: - type: string - example: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: - type: string - format: uri - example: https://api.github.com/users/octocat/subscriptions - organizations_url: - type: string - format: uri - example: https://api.github.com/users/octocat/orgs - repos_url: - type: string - format: uri - example: https://api.github.com/users/octocat/repos - events_url: - type: string - example: https://api.github.com/users/octocat/events{/privacy} - received_events_url: - type: string - format: uri - example: https://api.github.com/users/octocat/received_events - type: - type: string - example: User - site_admin: - type: boolean - starred_at: - type: string - example: '"2020-07-09T00:17:55Z"' - required: - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url webhooks_rule: title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch @@ -90842,6 +91890,8 @@ components: format: uri verified: type: boolean + enabled: + type: boolean required: - id - key @@ -90930,6 +91980,8 @@ components: type: string url: type: string + user_view_type: + type: string webhooks_reviewers: type: array items: @@ -91099,6 +92151,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -91241,6 +92295,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -91332,6 +92388,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -91534,172 +92592,176 @@ components: url: type: string format: uri - required: - - login - - id - labels: - type: array - items: - "$ref": "#/components/schemas/label" - required: - - repository_url - - category - - answer_html_url - - answer_chosen_at - - answer_chosen_by - - html_url - - id - - node_id - - number - - title - - user - - state - - state_reason - - locked - - comments - - created_at - - updated_at - - author_association - - active_lock_reason - - body - webhooks_comment: - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - type: string - child_comment_count: - type: integer - created_at: - type: string - discussion_id: - type: integer - html_url: - type: string - id: - type: integer - node_id: - type: string - parent_id: - type: integer - nullable: true - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: + user_view_type: + type: string + required: + - login + - id + labels: + type: array + items: + "$ref": "#/components/schemas/label" + required: + - repository_url + - category + - answer_html_url + - answer_chosen_at + - answer_chosen_by + - html_url + - id + - node_id + - number + - title + - user + - state + - state_reason + - locked + - comments + - created_at + - updated_at + - author_association + - active_lock_reason + - body + webhooks_comment: + type: object + properties: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + type: string + child_comment_count: + type: integer + created_at: + type: string + discussion_id: + type: integer + html_url: + type: string + id: + type: integer + node_id: + type: string + parent_id: + type: integer + nullable: true + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + updated_at: + type: string + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - updated_at: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri required: - login - id @@ -91954,6 +93016,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -92062,6 +93126,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -92132,6 +93198,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -92294,6 +93362,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -92504,6 +93574,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -92850,6 +93922,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -92954,6 +94028,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -93090,6 +94166,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -93159,6 +94237,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -93320,6 +94400,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -93528,6 +94610,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -93872,6 +94956,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -93962,6 +95048,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -94864,7 +95952,7 @@ components: use_squash_pr_title_as_default: type: boolean description: Whether a squash merge commit can use the pull request title - as default. **This property has been deprecated. Please use `squash_merge_commit_title` + as default. **This property is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true @@ -95093,6 +96181,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -95231,6 +96321,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -95344,6 +96436,15 @@ components: created_at: type: string description: Date and time when the request for access was created. + token_id: + type: integer + description: Unique identifier of the user's token. This field can also + be found in audit log events and the organization's settings for their + PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be + found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has @@ -95368,6 +96469,8 @@ components: - repository_count - repositories - created_at + - token_id + - token_name - token_expired - token_expires_at - token_last_used_at @@ -95456,116 +96559,120 @@ components: url: type: string format: uri - required: - - login - - id - id: - description: The project card's ID - type: integer - node_id: - type: string - note: - type: string - nullable: true - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - column_url - - column_id - - id - - node_id - - note - - archived - - creator - - created_at - - updated_at - webhooks_project: - title: Project - type: object - properties: - body: - description: Body of the project - type: string - nullable: true - columns_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: + user_view_type: + type: string + required: + - login + - id + id: + description: The project card's ID + type: integer + node_id: + type: string + note: + type: string + nullable: true + project_url: + type: string + format: uri + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - project_url + - column_url + - column_id + - id + - node_id + - note + - archived + - creator + - created_at + - updated_at + webhooks_project: + title: Project + type: object + properties: + body: + description: Body of the project + type: string + nullable: true + columns_url: + type: string + format: uri + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri required: - login - id @@ -95913,7 +97020,7 @@ components: - COMMIT_OR_PR_TITLE use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull request title - as default. **This property has been deprecated. Please use `squash_merge_commit_title` + as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** type: boolean default: false @@ -96081,6 +97188,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -96245,6 +97354,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -96574,6 +97685,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -96840,6 +97953,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -97193,6 +98308,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -97459,6 +98576,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -97595,6 +98714,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -97678,6 +98799,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -98107,6 +99230,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -98394,6 +99519,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -98553,6 +99680,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -98764,6 +99893,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -99090,6 +100221,8 @@ components: url: type: string format: uri + user_view_type: + type: string body: type: string nullable: true @@ -99367,6 +100500,15 @@ components: description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true + publicly_leaked: + type: boolean + description: Whether the detected secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: Whether the detected secret was found in multiple repositories + in the same organization or business. + nullable: true webhooks_security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -99523,6 +100665,8 @@ components: type: string url: type: string + user_view_type: + type: string node_id: type: string privacy_level: @@ -99591,6 +100735,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -99658,6 +100804,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -99879,7 +101027,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -99901,7 +101049,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -99925,7 +101073,7 @@ components: rule: "$ref": "#/components/schemas/webhooks_rule" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - rule @@ -99950,7 +101098,7 @@ components: rule: "$ref": "#/components/schemas/webhooks_rule" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - rule @@ -100081,7 +101229,7 @@ components: rule: "$ref": "#/components/schemas/webhooks_rule" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - rule @@ -100104,7 +101252,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - check_run - repository @@ -100137,7 +101285,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - check_run - repository @@ -100178,7 +101326,7 @@ components: user. type: string sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - check_run @@ -100212,7 +101360,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - check_run - repository @@ -100400,6 +101548,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -100824,7 +101974,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - check_suite @@ -101003,6 +102153,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -101425,7 +102577,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - check_suite @@ -101599,6 +102751,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -102020,7 +103174,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - check_suite @@ -102113,6 +103267,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -102264,7 +103420,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -102358,6 +103514,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -102528,7 +103686,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -102681,6 +103839,7 @@ components: state: description: State of a code scanning alert. type: string + nullable: true enum: - open - dismissed @@ -102732,7 +103891,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -102827,6 +103986,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -102999,7 +104160,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -103205,7 +104366,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -103378,7 +104539,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -103396,7 +104557,7 @@ components: enum: - created comment: - description: The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) + description: The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. type: object properties: @@ -103549,6 +104710,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -103575,7 +104738,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - comment @@ -103611,7 +104774,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - ref - ref_type @@ -103637,7 +104800,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - definition @@ -103664,7 +104827,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - definition @@ -103685,7 +104848,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - definition @@ -103706,7 +104869,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" new_property_values: type: array description: The new custom property values for the repository. @@ -103746,7 +104909,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - ref - ref_type @@ -103772,7 +104935,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -103797,7 +104960,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -103822,7 +104985,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -103847,7 +105010,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -103872,7 +105035,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -103897,7 +105060,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -103922,7 +105085,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -103947,7 +105110,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - key @@ -103972,7 +105135,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - key @@ -104057,6 +105220,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -104227,6 +105392,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -104472,7 +105639,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow: "$ref": "#/components/schemas/webhooks_workflow" workflow_run: @@ -104544,6 +105711,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -105031,6 +106200,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -105106,7 +106277,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" webhook-deployment-review-approved: type: object properties: @@ -105129,7 +106300,7 @@ components: reviewers: "$ref": "#/components/schemas/webhooks_reviewers" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" since: type: string workflow_job_run: @@ -105225,6 +106396,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -105373,6 +106546,8 @@ components: type: string url: type: string + user_view_type: + type: string private: type: boolean pulls_url: @@ -105612,6 +106787,8 @@ components: type: string url: type: string + user_view_type: + type: string private: type: boolean pulls_url: @@ -105716,6 +106893,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -105782,7 +106961,7 @@ components: reviewers: "$ref": "#/components/schemas/webhooks_reviewers" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" since: type: string workflow_job_run: @@ -105879,6 +107058,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -106025,6 +107206,8 @@ components: type: string url: type: string + user_view_type: + type: string private: type: boolean pulls_url: @@ -106264,6 +107447,8 @@ components: type: string url: type: string + user_view_type: + type: string private: type: boolean pulls_url: @@ -106367,6 +107552,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -106501,6 +107688,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - id type: @@ -106509,7 +107698,7 @@ components: - User - Team sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" since: type: string workflow_job_run: @@ -106610,6 +107799,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -106756,6 +107947,8 @@ components: type: string url: type: string + user_view_type: + type: string private: type: boolean pulls_url: @@ -106995,6 +108188,8 @@ components: type: string url: type: string + user_view_type: + type: string private: type: boolean pulls_url: @@ -107099,6 +108294,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -107299,6 +108496,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -107470,6 +108669,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -107776,6 +108977,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -107949,6 +109152,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -108185,7 +109390,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow: "$ref": "#/components/schemas/webhooks_workflow" workflow_run: @@ -108257,6 +109462,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -108745,6 +109952,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -108809,7 +110018,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -108879,7 +110088,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -108905,7 +110114,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -108932,7 +110141,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - comment @@ -108960,7 +110169,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - comment @@ -109000,7 +110209,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -109027,7 +110236,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -109052,7 +110261,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -109094,7 +110303,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -109121,7 +110330,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -109147,7 +110356,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -109172,7 +110381,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -109197,7 +110406,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -109232,7 +110441,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -109256,7 +110465,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -109283,7 +110492,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -109309,7 +110518,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -109334,7 +110543,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - discussion @@ -109631,6 +110840,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -110011,7 +111222,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - forkee - repository @@ -110025,7 +111236,7 @@ components: enum: - revoked sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - sender @@ -110078,7 +111289,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - pages - repository @@ -110104,7 +111315,7 @@ components: requester: "$ref": "#/components/schemas/webhooks_user" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - installation @@ -110130,7 +111341,7 @@ components: requester: nullable: true sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - installation @@ -110156,7 +111367,7 @@ components: requester: nullable: true sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - installation @@ -110204,7 +111415,7 @@ components: requester: "$ref": "#/components/schemas/webhooks_user" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - installation @@ -110262,7 +111473,7 @@ components: requester: "$ref": "#/components/schemas/webhooks_user" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - installation @@ -110292,7 +111503,7 @@ components: requester: nullable: true sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - installation @@ -110376,6 +111587,8 @@ components: type: string website_url: nullable: true + user_view_type: + type: string required: - id - node_id @@ -110411,7 +111624,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" target_type: type: string required: @@ -110441,7 +111654,7 @@ components: requester: nullable: true sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - installation @@ -110601,6 +111814,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -110704,6 +111919,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -110774,6 +111991,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -110936,6 +112155,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -111147,6 +112368,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -111494,6 +112717,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -111589,6 +112814,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -111754,7 +112981,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -111858,6 +113085,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -111928,6 +113157,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -112090,6 +113321,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -112299,6 +113532,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -112644,6 +113879,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -112739,6 +113976,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -112894,6 +114133,8 @@ components: type: string url: type: string + user_view_type: + type: string required: - labels - state @@ -112904,7 +114145,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -113010,6 +114251,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -113080,6 +114323,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -113242,6 +114487,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -113453,6 +114700,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -113799,6 +115048,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -113894,6 +115145,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -114059,7 +115312,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -114089,7 +115342,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -114191,6 +115444,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -114261,6 +115516,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -114423,6 +115680,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -114635,6 +115894,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -114981,6 +116242,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -115136,6 +116399,8 @@ components: type: string url: type: string + user_view_type: + type: string required: - state - closed_at @@ -115144,7 +116409,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -115241,6 +116506,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -115471,6 +116738,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -115680,6 +116949,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -116024,6 +117295,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -116054,7 +117327,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -116427,6 +117700,8 @@ components: url: type: string format: uri + user_view_type: + type: string description: type: string nullable: true @@ -116628,6 +117903,8 @@ components: url: type: string format: uri + user_view_type: + type: string permissions: description: The set of permissions for the GitHub app type: object @@ -116964,6 +118241,8 @@ components: url: type: string format: uri + user_view_type: + type: string milestone: "$ref": "#/components/schemas/webhooks_milestone" organization: @@ -116971,7 +118250,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -117089,6 +118368,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -117321,6 +118602,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -117532,6 +118815,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -117878,6 +119163,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -117910,7 +119197,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -118009,6 +119296,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -118241,6 +119530,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -118451,6 +119742,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -118797,6 +120090,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -118829,7 +120124,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -118952,6 +120247,8 @@ components: url: type: string format: uri + user_view_type: + type: string assignees: type: array items: @@ -119021,6 +120318,8 @@ components: url: type: string format: uri + user_view_type: + type: string author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -119202,6 +120501,8 @@ components: url: type: string format: uri + user_view_type: + type: string description: type: string nullable: true @@ -119405,6 +120706,8 @@ components: url: type: string format: uri + user_view_type: + type: string permissions: description: The set of permissions for the GitHub app type: object @@ -119739,12 +121042,14 @@ components: url: type: string format: uri + user_view_type: + type: string organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -120115,6 +121420,8 @@ components: url: type: string format: uri + user_view_type: + type: string description: type: string nullable: true @@ -120317,6 +121624,8 @@ components: url: type: string format: uri + user_view_type: + type: string permissions: description: The set of permissions for the GitHub app type: object @@ -120652,6 +121961,8 @@ components: url: type: string format: uri + user_view_type: + type: string milestone: "$ref": "#/components/schemas/webhooks_milestone" organization: @@ -120659,7 +121970,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -120757,6 +122068,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -120826,6 +122139,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -120987,6 +122302,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -121196,6 +122513,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -121540,6 +122859,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -121855,6 +123176,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -122111,6 +123434,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -122180,6 +123505,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -122342,6 +123669,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -122553,6 +123882,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -122898,6 +124229,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -122928,7 +124261,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -122953,7 +124286,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -123326,6 +124659,8 @@ components: url: type: string format: uri + user_view_type: + type: string description: type: string nullable: true @@ -123529,6 +124864,8 @@ components: url: type: string format: uri + user_view_type: + type: string permissions: description: The set of permissions for the GitHub app type: object @@ -123866,12 +125203,14 @@ components: url: type: string format: uri + user_view_type: + type: string organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -123967,6 +125306,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -124036,6 +125377,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -124197,6 +125540,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -124406,6 +125751,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -124750,6 +126097,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -125066,6 +126415,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -125252,7 +126603,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -125281,7 +126632,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -125308,7 +126659,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -125431,6 +126782,8 @@ components: url: type: string format: uri + user_view_type: + type: string assignees: type: array items: @@ -125500,6 +126853,8 @@ components: url: type: string format: uri + user_view_type: + type: string author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -125681,6 +127036,8 @@ components: url: type: string format: uri + user_view_type: + type: string description: type: string nullable: true @@ -125882,6 +127239,8 @@ components: url: type: string format: uri + user_view_type: + type: string permissions: description: The set of permissions for the GitHub app type: object @@ -126216,12 +127575,14 @@ components: url: type: string format: uri + user_view_type: + type: string organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -126246,7 +127607,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - issue @@ -126271,7 +127632,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - label @@ -126295,7 +127656,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - label @@ -126351,7 +127712,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - label @@ -126380,7 +127741,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - effective_date @@ -126489,7 +127850,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - effective_date @@ -126597,7 +127958,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - effective_date @@ -126705,7 +128066,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - effective_date @@ -126734,7 +128095,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - effective_date @@ -126786,7 +128147,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - member @@ -126833,7 +128194,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -126859,7 +128220,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - member @@ -126952,6 +128313,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -127052,6 +128415,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -127080,7 +128445,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - merge_group @@ -127109,7 +128474,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - merge_group @@ -127237,7 +128602,7 @@ components: repository: "$ref": "#/components/schemas/nullable-repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - hook_id @@ -127261,7 +128626,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - milestone @@ -127286,7 +128651,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - milestone @@ -127311,7 +128676,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - milestone @@ -127367,7 +128732,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -127393,7 +128758,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - milestone @@ -127418,7 +128783,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - blocked_user @@ -127443,7 +128808,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - blocked_user @@ -127468,7 +128833,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - organization @@ -127492,7 +128857,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - membership @@ -127596,6 +128961,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -127627,7 +128994,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" user: "$ref": "#/components/schemas/webhooks_user" required: @@ -127654,7 +129021,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - membership @@ -127687,7 +129054,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - organization @@ -127824,6 +129191,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -127897,6 +129266,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -128191,6 +129562,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -128298,7 +129671,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - package @@ -128401,6 +129774,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -128473,6 +129848,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -128624,6 +130001,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -128737,7 +130116,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - package @@ -128831,6 +130210,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -128861,7 +130242,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - id - build @@ -128882,7 +130263,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" installation: "$ref": "#/components/schemas/simple-installation" required: @@ -128906,7 +130287,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" installation: "$ref": "#/components/schemas/simple-installation" required: @@ -128930,7 +130311,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" installation: "$ref": "#/components/schemas/simple-installation" required: @@ -128953,7 +130334,7 @@ components: enterprise: "$ref": "#/components/schemas/enterprise-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" installation: "$ref": "#/components/schemas/simple-installation" required: @@ -129044,7 +130425,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" zen: description: Random string of GitHub zen. type: string @@ -129089,7 +130470,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -129114,7 +130495,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project_card @@ -129220,6 +130601,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -129255,7 +130638,7 @@ components: repository: "$ref": "#/components/schemas/nullable-repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project_card @@ -129292,7 +130675,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -129411,6 +130794,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -129514,7 +130899,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project_card @@ -129538,7 +130923,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project @@ -129562,7 +130947,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project_column @@ -129585,7 +130970,7 @@ components: repository: "$ref": "#/components/schemas/nullable-repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project_column @@ -129618,7 +131003,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -129642,7 +131027,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project_column @@ -129666,7 +131051,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project @@ -129690,7 +131075,7 @@ components: repository: "$ref": "#/components/schemas/nullable-repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project @@ -129734,7 +131119,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project @@ -129757,7 +131142,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - project @@ -129777,7 +131162,7 @@ components: projects_v2: "$ref": "#/components/schemas/projects-v2" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2 @@ -129798,7 +131183,7 @@ components: projects_v2: "$ref": "#/components/schemas/projects-v2" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2 @@ -129819,7 +131204,7 @@ components: projects_v2: "$ref": "#/components/schemas/projects-v2" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2 @@ -129875,7 +131260,7 @@ components: projects_v2: "$ref": "#/components/schemas/projects-v2" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2 @@ -129899,7 +131284,7 @@ components: projects_v2_item: "$ref": "#/components/schemas/projects-v2-item" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_item @@ -129932,7 +131317,7 @@ components: projects_v2_item: "$ref": "#/components/schemas/projects-v2-item" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_item @@ -129954,7 +131339,7 @@ components: projects_v2_item: "$ref": "#/components/schemas/projects-v2-item" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_item @@ -129975,7 +131360,7 @@ components: projects_v2_item: "$ref": "#/components/schemas/projects-v2-item" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_item @@ -130043,7 +131428,7 @@ components: projects_v2_item: "$ref": "#/components/schemas/projects-v2-item" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_item @@ -130076,7 +131461,7 @@ components: projects_v2_item: "$ref": "#/components/schemas/projects-v2-item" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_item @@ -130100,7 +131485,7 @@ components: projects_v2_item: "$ref": "#/components/schemas/projects-v2-item" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_item @@ -130122,7 +131507,7 @@ components: projects_v2: "$ref": "#/components/schemas/projects-v2" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2 @@ -130143,7 +131528,7 @@ components: projects_v2_status_update: "$ref": "#/components/schemas/projects-v2-status-update" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_status_update @@ -130164,7 +131549,7 @@ components: projects_v2_status_update: "$ref": "#/components/schemas/projects-v2-status-update" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_status_update @@ -130240,7 +131625,7 @@ components: projects_v2_status_update: "$ref": "#/components/schemas/projects-v2-status-update" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - projects_v2_status_update @@ -130259,7 +131644,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - repository - sender @@ -130445,6 +131830,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -130515,6 +131902,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -130609,6 +131998,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -130938,6 +132329,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -131044,7 +132437,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -131205,6 +132598,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -131560,6 +132955,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -131666,7 +133063,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -131827,6 +133224,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -131962,6 +133361,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -132045,6 +133446,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -132182,6 +133585,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -132486,6 +133891,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -132529,7 +133936,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -132716,6 +134123,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -132879,6 +134288,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -133208,6 +134619,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -133314,7 +134727,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -133475,6 +134888,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -133828,6 +135243,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -133934,7 +135351,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -134095,6 +135512,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -134230,6 +135649,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -134312,6 +135733,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -134449,6 +135872,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -134753,6 +136178,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -134798,7 +136225,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -134985,6 +136412,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -135148,6 +136577,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -135477,6 +136908,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -135583,7 +137016,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -135744,6 +137177,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -136096,6 +137531,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -136202,7 +137639,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -136363,6 +137800,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -136498,6 +137937,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -136581,6 +138022,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -136718,6 +138161,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -137022,6 +138467,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -137067,7 +138514,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -137095,7 +138542,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -137123,7 +138570,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -137151,7 +138598,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -137336,6 +138783,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -137499,6 +138948,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -137828,6 +139279,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -137934,7 +139387,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -138095,6 +139548,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -138448,6 +139903,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -138554,7 +140011,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -138715,6 +140172,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -138850,6 +140309,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -138933,6 +140394,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -139069,6 +140532,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -139364,6 +140829,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -139406,10 +140873,23 @@ components: - draft reason: type: string + enum: + - UNKNOWN_REMOVAL_REASON + - MANUAL + - MERGE + - MERGE_CONFLICT + - CI_FAILURE + - CI_TIMEOUT + - ALREADY_MERGED + - QUEUE_CLEARED + - ROLL_BACK + - BRANCH_PROTECTIONS + - GIT_TREE_INVALID + - INVALID_MERGE_COMMIT repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -139480,7 +140960,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -139666,6 +141146,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -139829,6 +141311,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -140158,6 +141642,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -140264,7 +141750,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -140425,6 +141911,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -140778,6 +142266,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -140884,7 +142374,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -141045,6 +142535,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -141180,6 +142672,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -141263,6 +142757,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -141399,6 +142895,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -141694,6 +143192,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -141737,7 +143237,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -141926,6 +143426,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -142090,6 +143592,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -142419,6 +143923,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -142525,7 +144031,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -142686,6 +144192,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -143041,6 +144549,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -143147,7 +144657,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -143308,6 +144818,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -143444,6 +144956,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -143527,6 +145041,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -143664,6 +145180,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -143968,6 +145486,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -144011,7 +145531,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -144197,6 +145717,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -144361,6 +145883,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -144690,6 +146214,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -144796,7 +146322,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -144957,6 +146483,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -145312,6 +146840,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -145418,7 +146948,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -145579,6 +147109,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -145715,6 +147247,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -145797,6 +147331,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -145934,6 +147470,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -146238,6 +147776,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -146281,7 +147821,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -146309,7 +147849,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -146336,7 +147876,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -146364,7 +147904,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -146392,7 +147932,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -146659,6 +148199,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -146855,6 +148397,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -147019,6 +148563,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -147348,6 +148894,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -147454,7 +149002,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -147615,6 +149163,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -147958,6 +149508,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -148064,7 +149616,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -148224,6 +149776,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -148363,6 +149917,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -148495,6 +150051,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -148794,6 +150352,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -148835,7 +150395,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - comment @@ -149018,6 +150578,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -149181,6 +150743,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -149510,6 +151074,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -149616,7 +151182,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -149777,6 +151343,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -150120,6 +151688,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -150226,7 +151796,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -150387,6 +151957,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -150525,6 +152097,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -150656,6 +152230,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -150946,6 +152522,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -150987,7 +152565,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - comment @@ -151172,6 +152750,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -151241,6 +152821,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -151335,6 +152917,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -151664,6 +153248,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -151770,7 +153356,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -151931,6 +153517,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -152274,6 +153862,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -152380,7 +153970,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -152541,6 +154131,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -152680,6 +154272,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -152811,6 +154405,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -153098,6 +154694,8 @@ components: - User - Organization - Mannequin + user_view_type: + type: string url: type: string format: uri @@ -153142,7 +154740,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -153326,6 +154924,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -153490,6 +155090,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -153819,6 +155421,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -153925,7 +155529,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -154086,6 +155690,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -154429,6 +156035,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -154535,7 +156143,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -154696,6 +156304,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -154834,6 +156444,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -154966,6 +156578,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -155265,6 +156879,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -155441,6 +157057,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -155457,7 +157075,7 @@ components: - author_association - _links sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - review @@ -155652,6 +157270,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -155816,6 +157436,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -156119,6 +157741,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -156353,6 +157977,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -156670,6 +158296,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -156904,6 +158532,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -157043,6 +158673,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -157175,6 +158807,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -157474,6 +159108,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -157519,7 +159155,7 @@ components: review: "$ref": "#/components/schemas/webhooks_review" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -157708,6 +159344,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -157777,6 +159415,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -157871,6 +159511,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -158200,6 +159842,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -158297,7 +159941,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -158458,6 +160102,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -158811,6 +160457,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -158917,7 +160565,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -159078,6 +160726,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -159213,6 +160863,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -159295,6 +160947,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -159431,6 +161085,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -159744,6 +161400,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -159850,11 +161508,13 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - requested_reviewer - action @@ -160040,6 +161700,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -160109,6 +161771,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -160203,6 +161867,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -160532,6 +162198,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -160638,7 +162306,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -160799,6 +162467,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -161152,6 +162822,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -161258,7 +162930,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -161419,6 +163091,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -161554,6 +163228,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -161636,6 +163312,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -161772,6 +163450,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -162085,6 +163765,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -162236,7 +163918,7 @@ components: - repositories_url - permission sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - requested_team - action @@ -162426,6 +164108,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -162496,6 +164180,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -162590,6 +164276,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -162919,6 +164607,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -163025,7 +164715,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -163186,6 +164876,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -163539,6 +165231,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -163645,7 +165339,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -163806,6 +165500,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -163941,6 +165637,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -164024,6 +165722,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -164160,6 +165860,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -164465,6 +166167,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -164572,11 +166276,13 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - requested_reviewer - action @@ -164763,6 +166469,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -164833,6 +166541,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -164927,6 +166637,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -165256,6 +166968,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -165362,7 +167076,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -165523,6 +167237,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -165876,6 +167592,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -165982,7 +167700,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -166143,6 +167861,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -166278,6 +167998,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -166361,6 +168083,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -166497,6 +168221,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -166793,6 +168519,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -166935,7 +168663,7 @@ components: - name - id sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - requested_team - action @@ -167119,6 +168847,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -167283,6 +169013,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -167612,6 +169344,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -167718,7 +169452,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -167879,6 +169613,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -168223,6 +169959,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -168329,7 +170067,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -168490,6 +170228,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -168629,6 +170369,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -168761,6 +170503,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -169060,6 +170804,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -169105,7 +170851,7 @@ components: review: "$ref": "#/components/schemas/webhooks_review" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - review @@ -169287,6 +171033,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -169450,6 +171198,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -169757,6 +171507,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -169996,6 +171748,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -170318,6 +172072,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -170557,6 +172313,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -170695,6 +172453,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -170827,6 +172587,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -171126,6 +172888,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -171169,7 +172933,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" thread: type: object properties: @@ -171430,6 +173194,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -171644,6 +173410,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -171806,6 +173574,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -172113,6 +173883,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -172352,6 +174124,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -172672,6 +174446,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -172911,6 +174687,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -173049,6 +174827,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -173180,6 +174960,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -173469,6 +175251,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -173512,7 +175296,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" thread: type: object properties: @@ -173771,6 +175555,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -173994,6 +175780,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -174158,6 +175946,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -174487,6 +176277,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -174593,7 +176385,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -174754,6 +176546,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -175098,6 +176892,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -175204,7 +177000,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -175365,6 +177161,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -175500,6 +177298,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -175583,6 +177383,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -175720,6 +177522,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -176024,6 +177828,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -176067,7 +177873,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -176258,6 +178064,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -176422,6 +178230,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -176752,6 +178562,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -176858,7 +178670,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -177019,6 +178831,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -177374,6 +179188,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -177480,7 +179296,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -177641,6 +179457,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -177777,6 +179595,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -177860,6 +179680,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -177997,6 +179819,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -178301,6 +180125,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -178344,7 +180170,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -178532,6 +180358,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -178696,6 +180524,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -179025,6 +180855,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -179131,7 +180963,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -179292,6 +181124,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -179638,6 +181472,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -179744,7 +181580,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -179905,6 +181741,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -180040,6 +181878,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -180123,6 +181963,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -180260,6 +182102,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -180564,6 +182408,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -180607,7 +182453,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -180793,6 +182639,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -180955,6 +182803,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -181284,6 +183134,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -181390,7 +183242,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -181551,6 +183403,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -181905,6 +183759,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -182011,7 +183867,7 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. + request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. type: boolean default: false @@ -182172,6 +184028,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -182307,6 +184165,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -182389,6 +184249,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -182525,6 +184387,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -182819,6 +184683,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -182862,7 +184728,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - number @@ -183402,6 +185268,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -183575,7 +185443,7 @@ components: - topics - visibility sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - ref - before @@ -183660,6 +185528,8 @@ components: type: string url: type: string + user_view_type: + type: string required: - login - id @@ -183724,6 +185594,8 @@ components: type: string url: type: string + user_view_type: + type: string required: - login - id @@ -184018,6 +185890,8 @@ components: type: string url: type: string + user_view_type: + type: string created_at: type: string draft: @@ -184099,7 +185973,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - registry_package @@ -184173,6 +186047,8 @@ components: type: string url: type: string + user_view_type: + type: string required: - login - id @@ -184236,6 +186112,8 @@ components: type: string url: type: string + user_view_type: + type: string required: - login - id @@ -184365,6 +186243,8 @@ components: type: string url: type: string + user_view_type: + type: string required: - login - id @@ -184471,7 +186351,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - registry_package @@ -184495,7 +186375,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - release @@ -184520,7 +186400,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - release @@ -184575,7 +186455,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -184811,6 +186691,8 @@ components: url: type: string format: uri + user_view_type: + type: string body: type: string nullable: true @@ -184904,7 +186786,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - release @@ -184928,7 +186810,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - release @@ -184952,7 +186834,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - release @@ -184976,7 +186858,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - release @@ -185000,7 +186882,7 @@ components: repository_advisory: "$ref": "#/components/schemas/repository-advisory" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -185024,7 +186906,7 @@ components: repository_advisory: "$ref": "#/components/schemas/repository-advisory" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -185046,7 +186928,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -185068,7 +186950,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -185090,7 +186972,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -185120,7 +187002,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - branch @@ -185179,7 +187061,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -185198,7 +187080,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" status: type: string enum: @@ -185226,7 +187108,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -185248,7 +187130,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -185287,7 +187169,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -185312,7 +187194,7 @@ components: repository_ruleset: "$ref": "#/components/schemas/repository-ruleset" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository_ruleset @@ -185336,7 +187218,7 @@ components: repository_ruleset: "$ref": "#/components/schemas/repository-ruleset" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository_ruleset @@ -185454,7 +187336,7 @@ components: from: type: string sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository_ruleset @@ -185594,6 +187476,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -185610,7 +187494,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - changes @@ -185633,7 +187517,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -185657,7 +187541,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -185771,6 +187655,8 @@ components: url: type: string format: uri + user_view_type: + type: string external_identifier: type: string external_reference: @@ -185807,7 +187693,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -185832,7 +187718,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -185977,7 +187863,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -186002,7 +187888,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -186026,7 +187912,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - location - alert @@ -186042,6 +187928,30 @@ components: type: string required: - payload + webhook-secret-scanning-alert-publicly-leaked: + title: secret_scanning_alert publicly leaked event + type: object + properties: + action: + type: string + enum: + - publicly_leaked + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-reopened: title: secret_scanning_alert reopened event type: object @@ -186061,7 +187971,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -186085,7 +187995,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -186109,7 +188019,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - alert @@ -186133,7 +188043,7 @@ components: security_advisory: "$ref": "#/components/schemas/webhooks_security_advisory" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - security_advisory @@ -186156,7 +188066,7 @@ components: security_advisory: "$ref": "#/components/schemas/webhooks_security_advisory" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - security_advisory @@ -186288,7 +188198,7 @@ components: - withdrawn_at - vulnerabilities sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - security_advisory @@ -186313,7 +188223,7 @@ components: repository: "$ref": "#/components/schemas/full-repository" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - changes - repository @@ -186334,7 +188244,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" sponsorship: "$ref": "#/components/schemas/webhooks_sponsorship" required: @@ -186358,7 +188268,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" sponsorship: "$ref": "#/components/schemas/webhooks_sponsorship" required: @@ -186394,7 +188304,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" sponsorship: "$ref": "#/components/schemas/webhooks_sponsorship" required: @@ -186421,7 +188331,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" sponsorship: "$ref": "#/components/schemas/webhooks_sponsorship" required: @@ -186449,7 +188359,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" sponsorship: "$ref": "#/components/schemas/webhooks_sponsorship" required: @@ -186476,7 +188386,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" sponsorship: "$ref": "#/components/schemas/webhooks_sponsorship" required: @@ -186501,7 +188411,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" starred_at: description: 'The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` @@ -186530,7 +188440,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" starred_at: description: 'The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` @@ -186896,7 +188806,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" sha: description: The Commit SHA. type: string @@ -186955,7 +188865,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - parent_issue_id @@ -186990,7 +188900,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - parent_issue_id @@ -187025,7 +188935,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - sub_issue_id @@ -187060,7 +188970,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - sub_issue_id @@ -187081,7 +188991,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" team: "$ref": "#/components/schemas/webhooks_team_1" required: @@ -187389,6 +189299,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -187557,7 +189469,7 @@ components: - topics - visibility sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" team: "$ref": "#/components/schemas/webhooks_team_1" required: @@ -187865,6 +189777,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -188033,7 +189947,7 @@ components: - topics - visibility sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" team: "$ref": "#/components/schemas/webhooks_team_1" required: @@ -188342,6 +190256,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -188510,7 +190426,7 @@ components: - topics - visibility sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" team: "$ref": "#/components/schemas/webhooks_team_1" required: @@ -188883,6 +190799,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -189051,7 +190969,7 @@ components: - topics - visibility sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" team: "$ref": "#/components/schemas/webhooks_team_1" required: @@ -189361,6 +191279,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -189529,7 +191449,7 @@ components: - topics - visibility sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" team: "$ref": "#/components/schemas/webhooks_team_1" required: @@ -189554,7 +191474,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" required: - action - repository @@ -189578,7 +191498,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow: type: string required: @@ -189604,7 +191524,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow_job: allOf: - title: Workflow Job @@ -189860,7 +191780,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow_job: allOf: - title: Workflow Job @@ -190139,7 +192059,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow_job: type: object properties: @@ -190297,7 +192217,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow_job: type: object properties: @@ -190456,7 +192376,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow: "$ref": "#/components/schemas/webhooks_workflow" workflow_run: @@ -190564,6 +192484,8 @@ components: url: type: string format: uri + user_view_type: + type: string artifacts_url: type: string format: uri @@ -190874,6 +192796,8 @@ components: url: type: string format: uri + user_view_type: + type: string private: description: Whether the repository is private or public. type: boolean @@ -191234,6 +193158,8 @@ components: url: type: string format: uri + user_view_type: + type: string private: description: Whether the repository is private or public. type: boolean @@ -191353,6 +193279,8 @@ components: url: type: string format: uri + user_view_type: + type: string updated_at: type: string format: date-time @@ -191392,7 +193320,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow: "$ref": "#/components/schemas/webhooks_workflow" workflow_run: @@ -192322,7 +194250,7 @@ components: repository: "$ref": "#/components/schemas/repository-webhooks" sender: - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" workflow: "$ref": "#/components/schemas/webhooks_workflow" workflow_run: @@ -192393,6 +194321,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -192657,6 +194587,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -193016,6 +194948,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -193182,6 +195116,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -196041,6 +197977,7 @@ components: pending_cancellation_date: last_activity_at: '2021-10-14T00:53:32-06:00' last_activity_editor: vscode/1.77.3/copilot/1.86.82 + plan_type: business assignee: login: octocat id: 1 @@ -196098,6 +198035,105 @@ components: received_events_url: https://api.github.com/users/octokitten/received_events type: User site_admin: false + copilot-usage-metrics-for-day: + value: + - date: '2024-06-24' + total_active_users: 24 + total_engaged_users: 20 + copilot_ide_code_completions: + total_engaged_users: 20 + languages: + - name: python + total_engaged_users: 10 + - name: ruby + total_engaged_users: 10 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 13 + languages: + - name: python + total_engaged_users: 6 + total_code_suggestions: 249 + total_code_acceptances: 123 + total_code_lines_suggested: 225 + total_code_lines_accepted: 135 + - name: ruby + total_engaged_users: 7 + total_code_suggestions: 496 + total_code_acceptances: 253 + total_code_lines_suggested: 520 + total_code_lines_accepted: 270 + - name: neovim + total_engaged_users: 7 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + languages: + - name: typescript + total_engaged_users: 3 + total_code_suggestions: 112 + total_code_acceptances: 56 + total_code_lines_suggested: 143 + total_code_lines_accepted: 61 + - name: go + total_engaged_users: 4 + total_code_suggestions: 132 + total_code_acceptances: 67 + total_code_lines_suggested: 154 + total_code_lines_accepted: 72 + copilot_ide_chat: + total_engaged_users: 13 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 12 + total_chats: 45 + total_chat_insertion_events: 12 + total_chat_copy_events: 16 + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_engaged_users: 1 + total_chats: 10 + total_chat_insertion_events: 11 + total_chat_copy_events: 3 + copilot_dotcom_chat: + total_engaged_users: 14 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 14 + total_chats: 38 + copilot_dotcom_pull_requests: + total_engaged_users: 12 + repositories: + - name: demo/repo1 + total_engaged_users: 8 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_pr_summaries_created: 6 + total_engaged_users: 8 + - name: demo/repo2 + total_engaged_users: 4 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_pr_summaries_created: 10 + total_engaged_users: 4 copilot-usage-metrics-enterprise: value: - day: '2023-10-15' @@ -196593,6 +198629,8 @@ components: push_protection_bypassed_at: '2020-11-06T21:48:51Z' resolution_comment: Example comment validity: active + publicly_leaked: false + multi_repo: false - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -196675,6 +198713,8 @@ components: push_protection_bypassed_at: resolution_comment: validity: unknown + publicly_leaked: false + multi_repo: false copilot-usage-metrics-org: value: - day: '2023-10-15' @@ -196887,6 +198927,7 @@ components: size: 23 truncated: false content: Hello world from GitHub + encoding: utf-8 public: true created_at: '2022-09-20T12:11:58Z' updated_at: '2022-09-21T10:28:06Z' @@ -198199,6 +200240,7 @@ components: members_can_fork_private_repositories: false web_commit_signoff_required: false updated_at: '2014-03-03T18:58:10Z' + deploy_keys_enabled_for_repositories: false dependency_graph_enabled_for_new_repositories: false dependabot_alerts_enabled_for_new_repositories: false dependabot_security_updates_enabled_for_new_repositories: false @@ -198364,6 +200406,309 @@ components: value: default_workflow_permissions: read can_approve_pull_request_reviews: true + runner-groups-org: + value: + total_count: 3 + runner_groups: + - id: 1 + name: Default + visibility: all + default: true + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners + inherited: false + allows_public_repositories: true + restricted_to_workflows: false + selected_workflows: [] + workflow_restrictions_read_only: false + - id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + inherited: true + allows_public_repositories: true + restricted_to_workflows: true + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: true + - id: 3 + name: expensive-hardware + visibility: private + default: false + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners + inherited: false + allows_public_repositories: true + restricted_to_workflows: false + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: false + runner-group: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + hosted_runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners + network_configuration_id: EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA + inherited: false + allows_public_repositories: true + restricted_to_workflows: true + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: false + runner-group-item: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + hosted_runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners + network_configuration_id: EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA + inherited: false + allows_public_repositories: true + restricted_to_workflows: true + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: false + minimal-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + organization: + language: + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + delete_branch_on_merge: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + forks: 1 + open_issues: 1 + watchers: 1 runner-paginated: value: total_count: 2 @@ -198984,6 +201329,12 @@ components: code_scanning_default_setup: enabled secret_scanning: enabled secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: enabled + secret_scanning_delegated_bypass_options: + reviewers: + - security_configuration_id: 17 + reviewer_id: 5678 + reviewer_type: TEAM secret_scanning_validity_checks: enabled secret_scanning_non_provider_patterns: enabled private_vulnerability_reporting: enabled @@ -199007,6 +201358,7 @@ components: code_scanning_default_setup: enabled secret_scanning: enabled secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled secret_scanning_validity_checks: disabled secret_scanning_non_provider_patterns: disabled private_vulnerability_reporting: enabled @@ -199031,6 +201383,7 @@ components: code_scanning_default_setup: disabled secret_scanning: enabled secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled secret_scanning_validity_checks: disabled secret_scanning_non_provider_patterns: disabled private_vulnerability_reporting: disabled @@ -199057,6 +201410,12 @@ components: code_scanning_default_setup: enabled secret_scanning: enabled secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: enabled + secret_scanning_delegated_bypass_options: + reviewers: + - security_configuration_id: 1325 + reviewer_id: 5678 + reviewer_type: TEAM secret_scanning_validity_checks: enabled secret_scanning_non_provider_patterns: enabled private_vulnerability_reporting: enabled @@ -199082,6 +201441,7 @@ components: code_scanning_default_setup: enabled secret_scanning: enabled secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled secret_scanning_validity_checks: disabled private_vulnerability_reporting: enabled enforcement: enforced @@ -199105,6 +201465,7 @@ components: code_scanning_default_setup: enabled secret_scanning: disabled secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled secret_scanning_validity_checks: disabled secret_scanning_non_provider_patterns: disabled private_vulnerability_reporting: disabled @@ -199622,7 +201983,11 @@ components: active_this_cycle: 12 inactive_this_cycle: 11 seat_management_setting: assign_selected + ide_chat: enabled + platform_chat: enabled + cli: enabled public_code_suggestions: block + plan_type: business organization-dependabot-secret-paginated: value: total_count: 3 @@ -199840,6 +202205,58 @@ components: updated_at: '2011-09-06T20:39:23Z' created_at: '2011-09-06T17:26:27Z' type: Organization + api-insights-route-stats: + value: + - http_method: GET + api_route: "/repositories/:repository_id" + total_request_count: 544665 + rate_limited_request_count: 13 + last_request_timestamp: '2024-09-18T15:43:03Z' + last_rate_limited_timestamp: '2024-09-18T06:30:09Z' + api-insights-subject-stats: + value: + - subject_type: installation + subject_id: 954453 + subject_name: GitHub Actions + integration_id: 124345 + total_request_count: 544665 + rate_limited_request_count: 13 + last_request_timestamp: '2024-09-18T15:43:03Z' + last_rate_limited_timestamp: '2024-09-18T06:30:09Z' + api-insights-summary-stats: + value: + total_request_count: 34225 + rate_limited_request_count: 23 + api-insights-time-stats: + value: + - timestamp: '2024-09-11T15:00:00Z' + total_request_count: 34225 + rate_limited_request_count: 0 + - timestamp: '2024-09-11T15:05:00Z' + total_request_count: 10587 + rate_limited_request_count: 18 + - timestamp: '2024-09-11T15:10:00Z' + total_request_count: 43587 + rate_limited_request_count: 14 + - timestamp: '2024-09-11T15:15:00Z' + total_request_count: 19463 + rate_limited_request_count: 4 + - timestamp: '2024-09-11T15:20:00Z' + total_request_count: 60542 + rate_limited_request_count: 3 + - timestamp: '2024-09-11T15:25:00Z' + total_request_count: 55872 + rate_limited_request_count: 23 + api-insights-user-stats: + value: + - actor_type: oauth_app + actor_id: 954453 + actor_name: GitHub Actions + oauth_application_id: 1245 + total_request_count: 544665 + rate_limited_request_count: 13 + last_request_timestamp: '2024-09-18T15:43:03Z' + last_rate_limited_timestamp: '2024-09-18T06:30:09Z' installation: value: id: 1 @@ -200134,6 +202551,7 @@ components: pending_cancellation_date: last_activity_at: '2021-10-14T00:53:32-06:00' last_activity_editor: vscode/1.77.3/copilot/1.86.82 + plan_type: business assignee: login: octocat id: 1 @@ -200945,6 +203363,8 @@ components: repository: metadata: read created_at: '2023-05-16T08:47:09.000-07:00' + token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -200978,6 +203398,8 @@ components: repository: metadata: read access_granted_at: '2023-05-16T08:47:09.000-07:00' + token_id: 98716 + token_name: Some Token token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: @@ -201664,7 +204086,7 @@ components: value: - id: 21 actor_id: 12 - username: octocat + actor_name: octocat before_sha: 893f768e172fb1bc9c5d6f3dd48557e45f14e01d after_sha: dedd88641a362b6b4ea872da4847d6131a164d01 ref: refs/heads/i-see-everything @@ -201674,7 +204096,7 @@ components: result: bypass - id: 25 actor_id: 11 - username: not-octocat + actor_name: not-octocat before_sha: 48994e4e01ccc943624c6231f172702b82b233cc after_sha: ecfd5a1025fa271a33ca5608d089476a2df3c9a1 ref: refs/heads/i-am-everything @@ -201687,7 +204109,7 @@ components: value: id: 21 actor_id: 12 - username: octocat + actor_name: octocat before_sha: 893f768e172fb1bc9c5d6f3dd48557e45f14e01d after_sha: dedd88641a362b6b4ea872da4847d6131a164d01 ref: refs/heads/i-see-everything @@ -206548,7 +208970,7 @@ components: analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 code-security-configuration-for-repository: value: - state: attached + status: attached configuration: id: 1325 target_type: organization @@ -206564,6 +208986,7 @@ components: code_scanning_default_setup: disabled secret_scanning: enabled secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled secret_scanning_validity_checks: disabled secret_scanning_non_provider_patterns: disabled private_vulnerability_reporting: disabled @@ -209065,18 +211488,36 @@ components: - 'Tool: GitHub.com-Dependency-Graph' name: github/example dataLicense: CC0-1.0 - documentDescribes: - - github/example - documentNamespace: https://github.com/github/example/dependency_graph/sbom-abcdef123456 + documentNamespace: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: - - SPDXID: SPDXRef-Package - name: rubygems:rails + - name: rails + SPDXID: SPDXRef-Package versionInfo: 1.0.0 downloadLocation: NOASSERTION filesAnalyzed: false licenseConcluded: MIT licenseDeclared: MIT copyrightText: Copyright (c) 1985 GitHub.com + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:gem/rails@1.0.0 + - name: github/example + SPDXID: SPDXRef-Repository + versionInfo: main + downloadLocation: NOASSERTION + filesAnalyzed: false + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:github/example@main + relationships: + - relationshipType: DEPENDS_ON + spdxElementId: SPDXRef-Repository + relatedSpdxElement: SPDXRef-Package + - relationshipType: DESCRIBES + spdxElementId: SPDXRef-DOCUMENT + relatedSpdxElement: SPDXRef-Repository dependency-graph-create-snapshot-request: value: version: 0 @@ -211079,6 +213520,7 @@ components: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true deploy-key: value: id: 1 @@ -211090,6 +213532,7 @@ components: read_only: true added_by: octocat last_used: '2022-01-10T15:53:42Z' + enabled: true label: value: id: 208045946 @@ -213789,6 +216232,8 @@ components: push_protection_bypassed_at: '2020-11-06T21:48:51Z' resolution_comment: Example comment validity: inactive + publicly_leaked: false + multi_repo: false - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -213806,6 +216251,8 @@ components: push_protection_bypassed_at: resolution_comment: validity: unknown + publicly_leaked: false + multi_repo: false secret-scanning-alert-open: value: number: 42 @@ -213825,6 +216272,8 @@ components: push_protection_bypassed_at: resolution_comment: validity: unknown + publicly_leaked: false + multi_repo: false secret-scanning-alert-resolved: value: number: 42 @@ -213862,6 +216311,8 @@ components: push_protection_bypassed_at: resolution_comment: Example comment validity: unknown + publicly_leaked: false + multi_repo: false secret-scanning-location-list: value: - type: commit @@ -215752,240 +218203,6 @@ components: updated_at: '2020-01-10T14:59:22Z' visibility: selected selected_repositories_url: https://api.github.com/user/codespaces/secrets/CODESPACE_GH_SECRET/repositories - minimal-repository-paginated: - value: - total_count: 1 - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - template_repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - organization: - language: - forks: 9 - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues: 0 - open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - delete_branch_on_merge: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - forks: 1 - open_issues: 1 - watchers: 1 user-export-details: value: state: succeeded @@ -219712,6 +221929,8 @@ components: resolved_by: secret_type: mailchimp_api_key secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 + publicly_leaked: false + multi_repo: false location: type: commit details: @@ -220098,6 +222317,31 @@ components: required: false schema: type: string + secret-scanning-alert-publicly-leaked: + name: is_publicly_leaked + in: query + description: A boolean value representing whether or not to filter alerts by + the publicly-leaked tag being present. + required: false + schema: + type: boolean + default: false + secret-scanning-alert-multi-repo: + name: is_multi_repo + in: query + description: A boolean value representing whether or not to filter alerts by + the multi-repo tag being present. + required: false + schema: + type: boolean + default: false + enterprise-team-slug: + name: team_slug + description: The slug of the enterprise team name. + in: path + required: true + schema: + type: string team-slug: name: team_slug description: The slug of the team name. @@ -220225,6 +222469,20 @@ components: required: true schema: type: integer + visible-to-repository: + name: visible_to_repository + description: Only return runner groups that are allowed to be used by this repository. + in: query + required: false + schema: + type: string + runner-group-id: + name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer runner-id: name: runner_id description: Unique identifier of the self-hosted runner. @@ -220302,6 +222560,88 @@ components: required: true schema: type: integer + api-insights-actor-type: + name: actor_type + in: path + description: The type of the actor + required: true + schema: + type: string + enum: + - installations + - classic_pats + - fine_grained_pats + - oauth_apps + - github_apps_user_to_server + api-insights-actor-id: + name: actor_id + in: path + description: The ID of the actor + required: true + schema: + type: integer + api-insights-min-timestamp: + name: min_timestamp + description: The minimum timestamp to query for stats + in: query + required: true + schema: + type: string + api-insights-max-timestamp: + name: max_timestamp + description: The maximum timestamp to query for stats + in: query + required: true + schema: + type: string + api-insights-route-stats-sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: array + items: + type: string + enum: + - last_rate_limited_timestamp + - last_request_timestamp + - rate_limited_request_count + - http_method + - api_route + - total_request_count + default: total_request_count + api-insights-sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: array + items: + type: string + enum: + - last_rate_limited_timestamp + - last_request_timestamp + - rate_limited_request_count + - subject_name + - total_request_count + default: total_request_count + api-insights-user-id: + name: user_id + in: path + description: The ID of the user to query for stats + required: true + schema: + type: string + api-insights-timestamp-increment: + name: timestamp_increment + description: The increment of time used to breakdown the query results (5m, + 10m, 1h, etc.) + in: query + required: true + schema: + type: string invitation-id: name: invitation_id description: The unique identifier of the invitation. @@ -220450,11 +222790,22 @@ components: type: integer custom-property-name: name: custom_property_name - description: The custom property name. The name is case sensitive. + description: The custom property name in: path required: true schema: type: string + ruleset-targets: + name: targets + description: | + A comma-separated list of rule targets to filter by. + If provided, only rulesets that apply to the specified targets will be returned. + For example, `branch,tag,push`. + in: query + required: false + schema: + type: string + example: branch,tag,push ref-in-query: name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally @@ -220836,6 +223187,13 @@ components: required: false schema: "$ref": "#/components/schemas/code-scanning-ref" + pr-alias: + name: pr + description: The number of the pull request for the results you want to list. + in: query + required: false + schema: + type: integer alert-number: name: alert_number in: path @@ -221157,6 +223515,13 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + usage_metrics_api_disabled: + description: Copilot Usage Merics API setting is disabled at the organization + or enterprise level. + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" service_unavailable: description: Service unavailable content: diff --git a/packages/openapi-typescript/examples/stripe-api.ts b/packages/openapi-typescript/examples/stripe-api.ts index 8fd2077d5..f8237c017 100644 --- a/packages/openapi-typescript/examples/stripe-api.ts +++ b/packages/openapi-typescript/examples/stripe-api.ts @@ -11,7 +11,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of an account.

*/ + /** + * Retrieve account + * @description

Retrieves the details of an account.

+ */ get: operations["GetAccount"]; put?: never; post?: never; @@ -30,7 +33,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

*/ + /** + * Create an account link + * @description

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

+ */ post: operations["PostAccountLinks"]; delete?: never; options?: never; @@ -47,7 +53,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.

*/ + /** + * Create an Account Session + * @description

Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.

+ */ post: operations["PostAccountSessions"]; delete?: never; options?: never; @@ -62,7 +71,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

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

*/ + /** + * List all connected accounts + * @description

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

+ */ get: operations["GetAccounts"]; put?: never; /** @description

With Connect, you can create Stripe accounts for your users. @@ -85,10 +97,15 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of an account.

*/ + /** + * Retrieve account + * @description

Retrieves the details of an account.

+ */ get: operations["GetAccountsAccount"]; put?: never; - /** @description

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are + /** + * Update an account + * @description

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are * left unchanged.

* *

For accounts where controller.requirement_collection @@ -100,15 +117,19 @@ export interface paths { * after which some properties can no longer be updated.

* *

To update your own account, use the Dashboard. Refer to our - * Connect documentation to learn more about updating accounts.

*/ + * Connect documentation to learn more about updating accounts.

+ */ post: operations["PostAccountsAccount"]; - /** @description

With Connect, you can delete accounts you manage.

+ /** + * Delete an account + * @description

With Connect, you can delete accounts you manage.

* *

Test-mode accounts can be deleted at any time.

* *

Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all balances are zero.

* - *

If you want to delete your own account, use the account information tab in your account settings instead.

*/ + *

If you want to delete your own account, use the account information tab in your account settings instead.

+ */ delete: operations["DeleteAccountsAccount"]; options?: never; head?: never; @@ -124,7 +145,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Create an external account for a given account.

*/ + /** + * Create an external account + * @description

Create an external account for a given account.

+ */ post: operations["PostAccountsAccountBankAccounts"]; delete?: never; options?: never; @@ -139,7 +163,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieve a specified external account for a given account.

*/ + /** + * Retrieve an external account + * @description

Retrieve a specified external account for a given account.

+ */ get: operations["GetAccountsAccountBankAccountsId"]; put?: never; /** @description

Updates the metadata, account holder name, account holder type of a bank account belonging to @@ -151,7 +178,10 @@ export interface paths { *

You can re-enable a disabled bank account by performing an update call without providing any * arguments or changes.

*/ post: operations["PostAccountsAccountBankAccountsId"]; - /** @description

Delete a specified external account for a given account.

*/ + /** + * Delete an external account + * @description

Delete a specified external account for a given account.

+ */ delete: operations["DeleteAccountsAccountBankAccountsId"]; options?: never; head?: never; @@ -165,7 +195,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

*/ + /** + * List all account capabilities + * @description

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

+ */ get: operations["GetAccountsAccountCapabilities"]; put?: never; post?: never; @@ -182,10 +215,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves information about the specified Account Capability.

*/ + /** + * Retrieve an Account Capability + * @description

Retrieves information about the specified Account Capability.

+ */ get: operations["GetAccountsAccountCapabilitiesCapability"]; put?: never; - /** @description

Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.

*/ + /** + * Update an Account Capability + * @description

Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.

+ */ post: operations["PostAccountsAccountCapabilitiesCapability"]; delete?: never; options?: never; @@ -200,10 +239,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

List external accounts for an account.

*/ + /** + * List all external accounts + * @description

List external accounts for an account.

+ */ get: operations["GetAccountsAccountExternalAccounts"]; put?: never; - /** @description

Create an external account for a given account.

*/ + /** + * Create an external account + * @description

Create an external account for a given account.

+ */ post: operations["PostAccountsAccountExternalAccounts"]; delete?: never; options?: never; @@ -218,7 +263,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieve a specified external account for a given account.

*/ + /** + * Retrieve an external account + * @description

Retrieve a specified external account for a given account.

+ */ get: operations["GetAccountsAccountExternalAccountsId"]; put?: never; /** @description

Updates the metadata, account holder name, account holder type of a bank account belonging to @@ -230,7 +278,10 @@ export interface paths { *

You can re-enable a disabled bank account by performing an update call without providing any * arguments or changes.

*/ post: operations["PostAccountsAccountExternalAccountsId"]; - /** @description

Delete a specified external account for a given account.

*/ + /** + * Delete an external account + * @description

Delete a specified external account for a given account.

+ */ delete: operations["DeleteAccountsAccountExternalAccountsId"]; options?: never; head?: never; @@ -246,9 +297,12 @@ export interface paths { }; get?: never; put?: never; - /** @description

Creates a single-use login link for a connected account to access the Express Dashboard.

+ /** + * Create a login link + * @description

Creates a login link for a connected account to access the Express Dashboard.

* - *

You can only create login links for accounts that use the Express Dashboard and are connected to your platform.

*/ + *

You can only create login links for accounts that use the Express Dashboard and are connected to your platform.

+ */ post: operations["PostAccountsAccountLoginLinks"]; delete?: never; options?: never; @@ -263,10 +317,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

*/ + /** + * List all persons + * @description

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

+ */ get: operations["GetAccountsAccountPeople"]; put?: never; - /** @description

Creates a new person.

*/ + /** + * Create a person + * @description

Creates a new person.

+ */ post: operations["PostAccountsAccountPeople"]; delete?: never; options?: never; @@ -281,12 +341,21 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves an existing person.

*/ + /** + * Retrieve a person + * @description

Retrieves an existing person.

+ */ get: operations["GetAccountsAccountPeoplePerson"]; put?: never; - /** @description

Updates an existing person.

*/ + /** + * Update a person + * @description

Updates an existing person.

+ */ post: operations["PostAccountsAccountPeoplePerson"]; - /** @description

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

*/ + /** + * Delete a person + * @description

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

+ */ delete: operations["DeleteAccountsAccountPeoplePerson"]; options?: never; head?: never; @@ -300,10 +369,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

*/ + /** + * List all persons + * @description

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

+ */ get: operations["GetAccountsAccountPersons"]; put?: never; - /** @description

Creates a new person.

*/ + /** + * Create a person + * @description

Creates a new person.

+ */ post: operations["PostAccountsAccountPersons"]; delete?: never; options?: never; @@ -318,12 +393,21 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves an existing person.

*/ + /** + * Retrieve a person + * @description

Retrieves an existing person.

+ */ get: operations["GetAccountsAccountPersonsPerson"]; put?: never; - /** @description

Updates an existing person.

*/ + /** + * Update a person + * @description

Updates an existing person.

+ */ post: operations["PostAccountsAccountPersonsPerson"]; - /** @description

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

*/ + /** + * Delete a person + * @description

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

+ */ delete: operations["DeleteAccountsAccountPersonsPerson"]; options?: never; head?: never; @@ -339,9 +423,12 @@ export interface paths { }; get?: never; put?: never; - /** @description

With Connect, you can reject accounts that you have flagged as suspicious.

+ /** + * Reject an account + * @description

With Connect, you can reject accounts that you have flagged as suspicious.

* - *

Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.

*/ + *

Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.

+ */ post: operations["PostAccountsAccountReject"]; delete?: never; options?: never; @@ -392,7 +479,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * List all application fees + * @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.

+ */ get: operations["GetApplicationFees"]; put?: never; post?: never; @@ -409,12 +499,18 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

*/ + /** + * Retrieve an application fee refund + * @description

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

+ */ get: operations["GetApplicationFeesFeeRefundsId"]; put?: never; - /** @description

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ /** + * Update an application fee refund + * @description

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* - *

This request only accepts metadata as an argument.

*/ + *

This request only accepts metadata as an argument.

+ */ post: operations["PostApplicationFeesFeeRefundsId"]; delete?: never; options?: never; @@ -429,7 +525,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

*/ + /** + * Retrieve an application fee + * @description

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

+ */ get: operations["GetApplicationFeesId"]; put?: never; post?: never; @@ -462,10 +561,15 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

*/ + /** + * List all application fee refunds + * @description

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

+ */ get: operations["GetApplicationFeesIdRefunds"]; put?: never; - /** @description

Refunds an application fee that has previously been collected but not yet refunded. + /** + * Create an application fee refund + * @description

Refunds an application fee that has previously been collected but not yet refunded. * Funds will be refunded to the Stripe account from which the fee was originally collected.

* *

You can optionally refund only part of an application fee. @@ -473,7 +577,8 @@ export interface paths { * *

Once entirely refunded, an application fee can’t be refunded again. * This method will raise an error when called on an already-refunded application fee, - * or when trying to refund more money than is left on an application fee.

*/ + * or when trying to refund more money than is left on an application fee.

+ */ post: operations["PostApplicationFeesIdRefunds"]; delete?: never; options?: never; @@ -488,10 +593,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

List all secrets stored on the given scope.

*/ + /** + * List secrets + * @description

List all secrets stored on the given scope.

+ */ get: operations["GetAppsSecrets"]; put?: never; - /** @description

Create or replace a secret in the secret store.

*/ + /** + * Set a Secret + * @description

Create or replace a secret in the secret store.

+ */ post: operations["PostAppsSecrets"]; delete?: never; options?: never; @@ -508,7 +619,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Deletes a secret from the secret store by name and scope.

*/ + /** + * Delete a Secret + * @description

Deletes a secret from the secret store by name and scope.

+ */ post: operations["PostAppsSecretsDelete"]; delete?: never; options?: never; @@ -523,7 +637,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Finds a secret in the secret store by name and scope.

*/ + /** + * Find a Secret + * @description

Finds a secret in the secret store by name and scope.

+ */ get: operations["GetAppsSecretsFind"]; put?: never; post?: never; @@ -540,8 +657,11 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the current account balance, based on the authentication that was used to make the request. - * For a sample request, see Accounting for negative balances.

*/ + /** + * Retrieve balance + * @description

Retrieves the current account balance, based on the authentication that was used to make the request. + * For a sample request, see Accounting for negative balances.

+ */ get: operations["GetBalance"]; put?: never; post?: never; @@ -558,9 +678,12 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

+ /** + * List all balance transactions + * @description

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* - *

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

*/ + *

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

+ */ get: operations["GetBalanceHistory"]; put?: never; post?: never; @@ -577,9 +700,12 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the balance transaction with the given ID.

+ /** + * Retrieve a balance transaction + * @description

Retrieves the balance transaction with the given ID.

* - *

Note that this endpoint previously used the path /v1/balance/history/:id.

*/ + *

Note that this endpoint previously used the path /v1/balance/history/:id.

+ */ get: operations["GetBalanceHistoryId"]; put?: never; post?: never; @@ -596,9 +722,12 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

+ /** + * List all balance transactions + * @description

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

* - *

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

*/ + *

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

+ */ get: operations["GetBalanceTransactions"]; put?: never; post?: never; @@ -615,9 +744,12 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the balance transaction with the given ID.

+ /** + * Retrieve a balance transaction + * @description

Retrieves the balance transaction with the given ID.

* - *

Note that this endpoint previously used the path /v1/balance/history/:id.

*/ + *

Note that this endpoint previously used the path /v1/balance/history/:id.

+ */ get: operations["GetBalanceTransactionsId"]; put?: never; post?: never; @@ -634,10 +766,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Lists billing active and inactive alerts

*/ + /** + * List billing alerts + * @description

Lists billing active and inactive alerts

+ */ get: operations["GetBillingAlerts"]; put?: never; - /** @description

Creates a billing alert

*/ + /** + * Create a billing alert + * @description

Creates a billing alert

+ */ post: operations["PostBillingAlerts"]; delete?: never; options?: never; @@ -652,7 +790,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a billing alert given an ID

*/ + /** + * Retrieve a billing alert + * @description

Retrieves a billing alert given an ID

+ */ get: operations["GetBillingAlertsId"]; put?: never; post?: never; @@ -671,7 +812,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Reactivates this alert, allowing it to trigger again.

*/ + /** + * Activate a billing alert + * @description

Reactivates this alert, allowing it to trigger again.

+ */ post: operations["PostBillingAlertsIdActivate"]; delete?: never; options?: never; @@ -688,7 +832,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Archives this alert, removing it from the list view and APIs. This is non-reversible.

*/ + /** + * Archive a billing alert + * @description

Archives this alert, removing it from the list view and APIs. This is non-reversible.

+ */ post: operations["PostBillingAlertsIdArchive"]; delete?: never; options?: never; @@ -705,7 +852,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Deactivates this alert, preventing it from triggering.

*/ + /** + * Deactivate a billing alert + * @description

Deactivates this alert, preventing it from triggering.

+ */ post: operations["PostBillingAlertsIdDeactivate"]; delete?: never; options?: never; @@ -713,6 +863,154 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/billing/credit_balance_summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve the credit balance summary for a customer + * @description

Retrieves the credit balance summary for a customer

+ */ + get: operations["GetBillingCreditBalanceSummary"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/credit_balance_transactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List credit balance transactions + * @description

Retrieve a list of credit balance transactions

+ */ + get: operations["GetBillingCreditBalanceTransactions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/credit_balance_transactions/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve a credit balance transaction + * @description

Retrieves a credit balance transaction

+ */ + get: operations["GetBillingCreditBalanceTransactionsId"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/credit_grants": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List credit grants + * @description

Retrieve a list of credit grants.

+ */ + get: operations["GetBillingCreditGrants"]; + put?: never; + /** + * Create a credit grant + * @description

Creates a credit grant

+ */ + post: operations["PostBillingCreditGrants"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/credit_grants/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve a credit grant + * @description

Retrieves a credit grant

+ */ + get: operations["GetBillingCreditGrantsId"]; + put?: never; + /** + * Update a credit grant + * @description

Updates a credit grant

+ */ + post: operations["PostBillingCreditGrantsId"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/credit_grants/{id}/expire": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Expire a credit grant + * @description

Expires a credit grant.

+ */ + post: operations["PostBillingCreditGrantsIdExpire"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/credit_grants/{id}/void": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Void a credit grant + * @description

Voids a credit grant.

+ */ + post: operations["PostBillingCreditGrantsIdVoid"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/billing/meter_event_adjustments": { parameters: { query?: never; @@ -722,7 +1020,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Creates a billing meter event adjustment

*/ + /** + * Create a billing meter event adjustment + * @description

Creates a billing meter event adjustment

+ */ post: operations["PostBillingMeterEventAdjustments"]; delete?: never; options?: never; @@ -739,7 +1040,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Creates a billing meter event

*/ + /** + * Create a billing meter event + * @description

Creates a billing meter event

+ */ post: operations["PostBillingMeterEvents"]; delete?: never; options?: never; @@ -754,10 +1058,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieve a list of billing meters.

*/ + /** + * List billing meters + * @description

Retrieve a list of billing meters.

+ */ get: operations["GetBillingMeters"]; put?: never; - /** @description

Creates a billing meter

*/ + /** + * Create a billing meter + * @description

Creates a billing meter

+ */ post: operations["PostBillingMeters"]; delete?: never; options?: never; @@ -772,10 +1082,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a billing meter given an ID

*/ + /** + * Retrieve a billing meter + * @description

Retrieves a billing meter given an ID

+ */ get: operations["GetBillingMetersId"]; put?: never; - /** @description

Updates a billing meter

*/ + /** + * Update a billing meter + * @description

Updates a billing meter

+ */ post: operations["PostBillingMetersId"]; delete?: never; options?: never; @@ -792,7 +1108,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Deactivates a billing meter

*/ + /** + * Deactivate a billing meter + * @description

Deactivates a billing meter

+ */ post: operations["PostBillingMetersIdDeactivate"]; delete?: never; options?: never; @@ -807,7 +1126,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieve a list of billing meter event summaries.

*/ + /** + * List billing meter event summaries + * @description

Retrieve a list of billing meter event summaries.

+ */ get: operations["GetBillingMetersIdEventSummaries"]; put?: never; post?: never; @@ -826,7 +1148,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Reactivates a billing meter

*/ + /** + * Reactivate a billing meter + * @description

Reactivates a billing meter

+ */ post: operations["PostBillingMetersIdReactivate"]; delete?: never; options?: never; @@ -841,10 +1166,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

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

*/ + /** + * List portal configurations + * @description

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

+ */ get: operations["GetBillingPortalConfigurations"]; put?: never; - /** @description

Creates a configuration that describes the functionality and behavior of a PortalSession

*/ + /** + * Create a portal configuration + * @description

Creates a configuration that describes the functionality and behavior of a PortalSession

+ */ post: operations["PostBillingPortalConfigurations"]; delete?: never; options?: never; @@ -859,10 +1190,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a configuration that describes the functionality of the customer portal.

*/ + /** + * Retrieve a portal configuration + * @description

Retrieves a configuration that describes the functionality of the customer portal.

+ */ get: operations["GetBillingPortalConfigurationsConfiguration"]; put?: never; - /** @description

Updates a configuration that describes the functionality of the customer portal.

*/ + /** + * Update a portal configuration + * @description

Updates a configuration that describes the functionality of the customer portal.

+ */ post: operations["PostBillingPortalConfigurationsConfiguration"]; delete?: never; options?: never; @@ -879,7 +1216,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Creates a session of the customer portal.

*/ + /** + * Create a portal session + * @description

Creates a session of the customer portal.

+ */ post: operations["PostBillingPortalSessions"]; delete?: never; options?: never; @@ -894,7 +1234,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

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

*/ + /** + * List all charges + * @description

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

+ */ get: operations["GetCharges"]; put?: never; /** @description

This method is no longer recommended—use the Payment Intents API @@ -914,10 +1257,13 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Search for charges you’ve previously created using Stripe’s Search Query Language. + /** + * Search charges + * @description

Search for charges you’ve previously created using Stripe’s Search Query Language. * Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up - * to an hour behind during outages. Search functionality is not available to merchants in India.

*/ + * to an hour behind during outages. Search functionality is not available to merchants in India.

+ */ get: operations["GetChargesSearch"]; put?: never; post?: never; @@ -934,10 +1280,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

*/ + /** + * Retrieve a charge + * @description

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

+ */ get: operations["GetChargesCharge"]; put?: never; - /** @description

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ + /** + * Update a charge + * @description

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ post: operations["PostChargesCharge"]; delete?: never; options?: never; @@ -954,11 +1306,14 @@ export interface paths { }; get?: never; put?: never; - /** @description

Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

+ /** + * Capture a payment + * @description

Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

* *

Uncaptured payments expire a set number of days after they are created (7 by default), after which they are marked as refunded and capture attempts will fail.

* - *

Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.

*/ + *

Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.

+ */ post: operations["PostChargesChargeCapture"]; delete?: never; options?: never; @@ -1008,7 +1363,9 @@ export interface paths { }; get?: never; put?: never; - /** @description

When you create a new refund, you must specify either a Charge or a PaymentIntent object.

+ /** + * Create a refund + * @description

When you create a new refund, you must specify either a Charge or a PaymentIntent object.

* *

This action refunds a previously created charge that’s not refunded yet. * Funds are refunded to the credit or debit card that’s originally charged.

@@ -1018,7 +1375,8 @@ export interface paths { * *

After you entirely refund a charge, you can’t refund it again. * This method raises an error when it’s called on an already-refunded charge, - * or when you attempt to refund more money than is left on a charge.

*/ + * or when you attempt to refund more money than is left on a charge.

+ */ post: operations["PostChargesChargeRefund"]; delete?: never; options?: never; @@ -1033,10 +1391,15 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

*/ + /** + * List all refunds + * @description

You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

+ */ get: operations["GetChargesChargeRefunds"]; put?: never; - /** @description

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

+ /** + * Create customer balance refund + * @description

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* *

Creating a new refund will refund a charge that has previously been created but not yet refunded. * Funds will be refunded to the credit or debit card that was originally charged.

@@ -1046,7 +1409,8 @@ export interface paths { * *

Once entirely refunded, a charge can’t be refunded again. * This method will raise an error when called on an already-refunded charge, - * or when trying to refund more money than is left on a charge.

*/ + * or when trying to refund more money than is left on a charge.

+ */ post: operations["PostChargesChargeRefunds"]; delete?: never; options?: never; @@ -1079,10 +1443,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of Checkout Sessions.

*/ + /** + * List all Checkout Sessions + * @description

Returns a list of Checkout Sessions.

+ */ get: operations["GetCheckoutSessions"]; put?: never; - /** @description

Creates a Session object.

*/ + /** + * Create a Session + * @description

Creates a Session object.

+ */ post: operations["PostCheckoutSessions"]; delete?: never; options?: never; @@ -1097,10 +1467,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a Session object.

*/ + /** + * Retrieve a Session + * @description

Retrieves a Session object.

+ */ get: operations["GetCheckoutSessionsSession"]; put?: never; - /** @description

Updates a Session object.

*/ + /** + * Update a Session + * @description

Updates a Session object.

+ */ post: operations["PostCheckoutSessionsSession"]; delete?: never; options?: never; @@ -1117,9 +1493,12 @@ export interface paths { }; get?: never; put?: never; - /** @description

A Session can be expired when it is in one of these statuses: open

+ /** + * Expire a Session + * @description

A Session can be expired when it is in one of these statuses: open

* - *

After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.

*/ + *

After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.

+ */ post: operations["PostCheckoutSessionsSessionExpire"]; delete?: never; options?: never; @@ -1134,7 +1513,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

When retrieving a Checkout Session, 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.

*/ + /** + * Retrieve a Checkout Session's line items + * @description

When retrieving a Checkout Session, 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["GetCheckoutSessionsSessionLineItems"]; put?: never; post?: never; @@ -1151,12 +1533,18 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Lists all Climate order objects. The orders are returned sorted by creation date, with the - * most recently created orders appearing first.

*/ + /** + * List orders + * @description

Lists all Climate order objects. The orders are returned sorted by creation date, with the + * most recently created orders appearing first.

+ */ get: operations["GetClimateOrders"]; put?: never; - /** @description

Creates a Climate order object for a given Climate product. The order will be processed immediately - * after creation and payment will be deducted your Stripe balance.

*/ + /** + * Create an order + * @description

Creates a Climate order object for a given Climate product. The order will be processed immediately + * after creation and payment will be deducted your Stripe balance.

+ */ post: operations["PostClimateOrders"]; delete?: never; options?: never; @@ -1171,10 +1559,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of a Climate order object with the given ID.

*/ + /** + * Retrieve an order + * @description

Retrieves the details of a Climate order object with the given ID.

+ */ get: operations["GetClimateOrdersOrder"]; put?: never; - /** @description

Updates the specified order by setting the values of the parameters passed.

*/ + /** + * Update an order + * @description

Updates the specified order by setting the values of the parameters passed.

+ */ post: operations["PostClimateOrdersOrder"]; delete?: never; options?: never; @@ -1191,10 +1585,13 @@ export interface paths { }; get?: never; put?: never; - /** @description

Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the + /** + * Cancel an order + * @description

Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the * reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier * might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe - * provides 90 days advance notice and refunds the amount_total.

*/ + * provides 90 days advance notice and refunds the amount_total.

+ */ post: operations["PostClimateOrdersOrderCancel"]; delete?: never; options?: never; @@ -1209,7 +1606,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Lists all available Climate product objects.

*/ + /** + * List products + * @description

Lists all available Climate product objects.

+ */ get: operations["GetClimateProducts"]; put?: never; post?: never; @@ -1226,7 +1626,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of a Climate product with the given ID.

*/ + /** + * Retrieve a product + * @description

Retrieves the details of a Climate product with the given ID.

+ */ get: operations["GetClimateProductsProduct"]; put?: never; post?: never; @@ -1243,7 +1646,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Lists all available Climate supplier objects.

*/ + /** + * List suppliers + * @description

Lists all available Climate supplier objects.

+ */ get: operations["GetClimateSuppliers"]; put?: never; post?: never; @@ -1260,7 +1666,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a Climate supplier object.

*/ + /** + * Retrieve a supplier + * @description

Retrieves a Climate supplier object.

+ */ get: operations["GetClimateSuppliersSupplier"]; put?: never; post?: never; @@ -1277,7 +1686,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves an existing ConfirmationToken object

*/ + /** + * Retrieve a ConfirmationToken + * @description

Retrieves an existing ConfirmationToken object

+ */ get: operations["GetConfirmationTokensConfirmationToken"]; put?: never; post?: never; @@ -1294,7 +1706,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Lists all Country Spec objects available in the API.

*/ + /** + * List Country Specs + * @description

Lists all Country Spec objects available in the API.

+ */ get: operations["GetCountrySpecs"]; put?: never; post?: never; @@ -1311,7 +1726,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a Country Spec for a given Country code.

*/ + /** + * Retrieve a Country Spec + * @description

Returns a Country Spec for a given Country code.

+ */ get: operations["GetCountrySpecsCountry"]; put?: never; post?: never; @@ -1328,12 +1746,18 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of your coupons.

*/ + /** + * List all coupons + * @description

Returns a list of your coupons.

+ */ get: operations["GetCoupons"]; put?: never; - /** @description

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

+ /** + * Create a coupon + * @description

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

* - *

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

*/ + *

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

+ */ post: operations["PostCoupons"]; delete?: never; options?: never; @@ -1348,12 +1772,21 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the coupon with the given ID.

*/ + /** + * Retrieve a coupon + * @description

Retrieves the coupon with the given ID.

+ */ get: operations["GetCouponsCoupon"]; put?: never; - /** @description

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

*/ + /** + * Update a coupon + * @description

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

+ */ post: operations["PostCouponsCoupon"]; - /** @description

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

*/ + /** + * Delete a coupon + * @description

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

+ */ delete: operations["DeleteCouponsCoupon"]; options?: never; head?: never; @@ -1367,10 +1800,15 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of credit notes.

*/ + /** + * List all credit notes + * @description

Returns a list of credit notes.

+ */ get: operations["GetCreditNotes"]; put?: never; - /** @description

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces + /** + * Create a credit note + * @description

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result * in any combination of the following:

* @@ -1383,7 +1821,8 @@ export interface paths { *

For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.

* *

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount - * or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

*/ + * or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

+ */ post: operations["PostCreditNotes"]; delete?: never; options?: never; @@ -1398,7 +1837,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Get a preview of a credit note without creating it.

*/ + /** + * Preview a credit note + * @description

Get a preview of a credit note without creating it.

+ */ get: operations["GetCreditNotesPreview"]; put?: never; post?: never; @@ -1415,7 +1857,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

*/ + /** + * Retrieve a credit note preview's line items + * @description

When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

+ */ get: operations["GetCreditNotesPreviewLines"]; put?: never; post?: never; @@ -1432,7 +1877,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

When retrieving a credit note, you’ll get a lines property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

*/ + /** + * Retrieve a credit note's line items + * @description

When retrieving a credit note, you’ll get a lines 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["GetCreditNotesCreditNoteLines"]; put?: never; post?: never; @@ -1449,10 +1897,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the credit note object with the given identifier.

*/ + /** + * Retrieve a credit note + * @description

Retrieves the credit note object with the given identifier.

+ */ get: operations["GetCreditNotesId"]; put?: never; - /** @description

Updates an existing credit note.

*/ + /** + * Update a credit note + * @description

Updates an existing credit note.

+ */ post: operations["PostCreditNotesId"]; delete?: never; options?: never; @@ -1469,7 +1923,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Marks a credit note as void. Learn more about voiding credit notes.

*/ + /** + * Void a credit note + * @description

Marks a credit note as void. Learn more about voiding credit notes.

+ */ post: operations["PostCreditNotesIdVoid"]; delete?: never; options?: never; @@ -1486,7 +1943,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

*/ + /** + * Create a Customer Session + * @description

Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

+ */ post: operations["PostCustomerSessions"]; delete?: never; options?: never; @@ -1501,10 +1961,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

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

*/ + /** + * List all customers + * @description

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

+ */ get: operations["GetCustomers"]; put?: never; - /** @description

Creates a new customer object.

*/ + /** + * Create a customer + * @description

Creates a new customer object.

+ */ post: operations["PostCustomers"]; delete?: never; options?: never; @@ -1519,10 +1985,13 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Search for customers you’ve previously created using Stripe’s Search Query Language. + /** + * Search customers + * @description

Search for customers you’ve previously created using Stripe’s Search Query Language. * Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up - * to an hour behind during outages. Search functionality is not available to merchants in India.

*/ + * to an hour behind during outages. Search functionality is not available to merchants in India.

+ */ get: operations["GetCustomersSearch"]; put?: never; post?: never; @@ -1539,14 +2008,23 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a Customer object.

*/ + /** + * Retrieve a customer + * @description

Retrieves a Customer object.

+ */ get: operations["GetCustomersCustomer"]; put?: never; - /** @description

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

+ /** + * Update a customer + * @description

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

* - *

This request accepts mostly the same arguments as the customer creation call.

*/ + *

This request accepts mostly the same arguments as the customer creation call.

+ */ post: operations["PostCustomersCustomer"]; - /** @description

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

*/ + /** + * Delete a customer + * @description

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

+ */ delete: operations["DeleteCustomersCustomer"]; options?: never; head?: never; @@ -1560,10 +2038,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of transactions that updated the customer’s balances.

*/ + /** + * List customer balance transactions + * @description

Returns a list of transactions that updated the customer’s balances.

+ */ get: operations["GetCustomersCustomerBalanceTransactions"]; put?: never; - /** @description

Creates an immutable transaction that updates the customer’s credit balance.

*/ + /** + * Create a customer balance transaction + * @description

Creates an immutable transaction that updates the customer’s credit balance.

+ */ post: operations["PostCustomersCustomerBalanceTransactions"]; delete?: never; options?: never; @@ -1578,10 +2062,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a specific customer balance transaction that updated the customer’s balances.

*/ + /** + * Retrieve a customer balance transaction + * @description

Retrieves a specific customer balance transaction that updated the customer’s balances.

+ */ get: operations["GetCustomersCustomerBalanceTransactionsTransaction"]; put?: never; - /** @description

Most credit balance transaction fields are immutable, but you may update its description and metadata.

*/ + /** + * Update a customer credit balance transaction + * @description

Most credit balance transaction fields are immutable, but you may update its description and metadata.

+ */ post: operations["PostCustomersCustomerBalanceTransactionsTransaction"]; delete?: never; options?: never; @@ -1597,16 +2087,20 @@ export interface paths { cookie?: never; }; /** + * List all bank accounts * @deprecated * @description

You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.

*/ get: operations["GetCustomersCustomerBankAccounts"]; put?: never; - /** @description

When you create a new credit card, you must specify a customer or recipient on which to create it.

+ /** + * Create a card + * @description

When you create a new credit card, you must specify a customer or recipient on which to create it.

* *

If the card’s owner has no default card, then the new card will become the default. * However, if the owner already has a default, then it will not change. - * To change the default, you should update the customer to have a new default_source.

*/ + * To change the default, you should update the customer to have a new default_source.

+ */ post: operations["PostCustomersCustomerBankAccounts"]; delete?: never; options?: never; @@ -1622,6 +2116,7 @@ export interface paths { cookie?: never; }; /** + * Retrieve a bank account * @deprecated * @description

By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.

*/ @@ -1629,7 +2124,10 @@ export interface paths { put?: never; /** @description

Update a specified source for a given customer.

*/ post: operations["PostCustomersCustomerBankAccountsId"]; - /** @description

Delete a specified source for a given customer.

*/ + /** + * Delete a customer source + * @description

Delete a specified source for a given customer.

+ */ delete: operations["DeleteCustomersCustomerBankAccountsId"]; options?: never; head?: never; @@ -1645,7 +2143,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Verify a specified bank account for a given customer.

*/ + /** + * Verify a bank account + * @description

Verify a specified bank account for a given customer.

+ */ post: operations["PostCustomersCustomerBankAccountsIdVerify"]; delete?: never; options?: never; @@ -1661,6 +2162,7 @@ export interface paths { cookie?: never; }; /** + * List all cards * @deprecated * @description

You can see a list of the cards belonging to a customer. * Note that the 10 most recent sources are always available on the Customer object. @@ -1668,11 +2170,14 @@ export interface paths { */ get: operations["GetCustomersCustomerCards"]; put?: never; - /** @description

When you create a new credit card, you must specify a customer or recipient on which to create it.

+ /** + * Create a card + * @description

When you create a new credit card, you must specify a customer or recipient on which to create it.

* *

If the card’s owner has no default card, then the new card will become the default. * However, if the owner already has a default, then it will not change. - * To change the default, you should update the customer to have a new default_source.

*/ + * To change the default, you should update the customer to have a new default_source.

+ */ post: operations["PostCustomersCustomerCards"]; delete?: never; options?: never; @@ -1688,6 +2193,7 @@ export interface paths { cookie?: never; }; /** + * Retrieve a card * @deprecated * @description

You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.

*/ @@ -1695,7 +2201,10 @@ export interface paths { put?: never; /** @description

Update a specified source for a given customer.

*/ post: operations["PostCustomersCustomerCardsId"]; - /** @description

Delete a specified source for a given customer.

*/ + /** + * Delete a customer source + * @description

Delete a specified source for a given customer.

+ */ delete: operations["DeleteCustomersCustomerCardsId"]; options?: never; head?: never; @@ -1709,10 +2218,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a customer’s cash balance.

*/ + /** + * Retrieve a cash balance + * @description

Retrieves a customer’s cash balance.

+ */ get: operations["GetCustomersCustomerCashBalance"]; put?: never; - /** @description

Changes the settings on a customer’s cash balance.

*/ + /** + * Update a cash balance's settings + * @description

Changes the settings on a customer’s cash balance.

+ */ post: operations["PostCustomersCustomerCashBalance"]; delete?: never; options?: never; @@ -1727,7 +2242,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of transactions that modified the customer’s cash balance.

*/ + /** + * List cash balance transactions + * @description

Returns a list of transactions that modified the customer’s cash balance.

+ */ get: operations["GetCustomersCustomerCashBalanceTransactions"]; put?: never; post?: never; @@ -1744,7 +2262,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

*/ + /** + * Retrieve a cash balance transaction + * @description

Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

+ */ get: operations["GetCustomersCustomerCashBalanceTransactionsTransaction"]; put?: never; post?: never; @@ -1764,7 +2285,10 @@ export interface paths { get: operations["GetCustomersCustomerDiscount"]; put?: never; post?: never; - /** @description

Removes the currently applied discount on a customer.

*/ + /** + * Delete a customer discount + * @description

Removes the currently applied discount on a customer.

+ */ delete: operations["DeleteCustomersCustomerDiscount"]; options?: never; head?: never; @@ -1780,9 +2304,12 @@ export interface paths { }; get?: never; put?: never; - /** @description

Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new + /** + * Create or retrieve funding instructions for a customer cash balance + * @description

Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new * funding instructions will be created. If funding instructions have already been created for a given customer, the same - * funding instructions will be retrieved. In other words, we will return the same funding instructions each time.

*/ + * funding instructions will be retrieved. In other words, we will return the same funding instructions each time.

+ */ post: operations["PostCustomersCustomerFundingInstructions"]; delete?: never; options?: never; @@ -1797,7 +2324,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of PaymentMethods for a given Customer

*/ + /** + * List a Customer's PaymentMethods + * @description

Returns a list of PaymentMethods for a given Customer

+ */ get: operations["GetCustomersCustomerPaymentMethods"]; put?: never; post?: never; @@ -1814,7 +2344,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a PaymentMethod object for a given Customer.

*/ + /** + * Retrieve a Customer's PaymentMethod + * @description

Retrieves a PaymentMethod object for a given Customer.

+ */ get: operations["GetCustomersCustomerPaymentMethodsPaymentMethod"]; put?: never; post?: never; @@ -1834,11 +2367,14 @@ export interface paths { /** @description

List sources for a specified customer.

*/ get: operations["GetCustomersCustomerSources"]; put?: never; - /** @description

When you create a new credit card, you must specify a customer or recipient on which to create it.

+ /** + * Create a card + * @description

When you create a new credit card, you must specify a customer or recipient on which to create it.

* *

If the card’s owner has no default card, then the new card will become the default. * However, if the owner already has a default, then it will not change. - * To change the default, you should update the customer to have a new default_source.

*/ + * To change the default, you should update the customer to have a new default_source.

+ */ post: operations["PostCustomersCustomerSources"]; delete?: never; options?: never; @@ -1858,7 +2394,10 @@ export interface paths { put?: never; /** @description

Update a specified source for a given customer.

*/ post: operations["PostCustomersCustomerSourcesId"]; - /** @description

Delete a specified source for a given customer.

*/ + /** + * Delete a customer source + * @description

Delete a specified source for a given customer.

+ */ delete: operations["DeleteCustomersCustomerSourcesId"]; options?: never; head?: never; @@ -1874,7 +2413,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Verify a specified bank account for a given customer.

*/ + /** + * Verify a bank account + * @description

Verify a specified bank account for a given customer.

+ */ post: operations["PostCustomersCustomerSourcesIdVerify"]; delete?: never; options?: never; @@ -1889,10 +2431,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.

*/ + /** + * List active subscriptions + * @description

You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.

+ */ get: operations["GetCustomersCustomerSubscriptions"]; put?: never; - /** @description

Creates a new subscription on an existing customer.

*/ + /** + * Create a subscription + * @description

Creates a new subscription on an existing customer.

+ */ post: operations["PostCustomersCustomerSubscriptions"]; delete?: never; options?: never; @@ -1907,16 +2455,25 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the subscription with the given ID.

*/ + /** + * Retrieve a subscription + * @description

Retrieves the subscription with the given ID.

+ */ get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedId"]; put?: never; - /** @description

Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.

*/ + /** + * Update a subscription on a customer + * @description

Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.

+ */ post: operations["PostCustomersCustomerSubscriptionsSubscriptionExposedId"]; - /** @description

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

+ /** + * Cancel a subscription + * @description

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

* *

Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

* - *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

*/ + *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

+ */ delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedId"]; options?: never; head?: never; @@ -1933,7 +2490,10 @@ export interface paths { get: operations["GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; put?: never; post?: never; - /** @description

Removes the currently applied discount on a customer.

*/ + /** + * Delete a customer discount + * @description

Removes the currently applied discount on a customer.

+ */ delete: operations["DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount"]; options?: never; head?: never; @@ -1947,10 +2507,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of tax IDs for a customer.

*/ + /** + * List all Customer tax IDs + * @description

Returns a list of tax IDs for a customer.

+ */ get: operations["GetCustomersCustomerTaxIds"]; put?: never; - /** @description

Creates a new tax_id object for a customer.

*/ + /** + * Create a Customer tax ID + * @description

Creates a new tax_id object for a customer.

+ */ post: operations["PostCustomersCustomerTaxIds"]; delete?: never; options?: never; @@ -1965,11 +2531,17 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the tax_id object with the given identifier.

*/ + /** + * Retrieve a Customer tax ID + * @description

Retrieves the tax_id object with the given identifier.

+ */ get: operations["GetCustomersCustomerTaxIdsId"]; put?: never; post?: never; - /** @description

Deletes an existing tax_id object.

*/ + /** + * Delete a Customer tax ID + * @description

Deletes an existing tax_id object.

+ */ delete: operations["DeleteCustomersCustomerTaxIdsId"]; options?: never; head?: never; @@ -1983,7 +2555,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of your disputes.

*/ + /** + * List all disputes + * @description

Returns a list of your disputes.

+ */ get: operations["GetDisputes"]; put?: never; post?: never; @@ -2000,12 +2575,18 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the dispute with the given ID.

*/ + /** + * Retrieve a dispute + * @description

Retrieves the dispute with the given ID.

+ */ get: operations["GetDisputesDispute"]; put?: never; - /** @description

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

+ /** + * Update a dispute + * @description

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

* - *

Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.

*/ + *

Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.

+ */ post: operations["PostDisputesDispute"]; delete?: never; options?: never; @@ -2022,9 +2603,12 @@ export interface paths { }; get?: never; put?: never; - /** @description

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

+ /** + * Close a dispute + * @description

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

* - *

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

*/ + *

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

+ */ post: operations["PostDisputesDisputeClose"]; delete?: never; options?: never; @@ -2039,7 +2623,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieve a list of active entitlements for a customer

*/ + /** + * List all active entitlements + * @description

Retrieve a list of active entitlements for a customer

+ */ get: operations["GetEntitlementsActiveEntitlements"]; put?: never; post?: never; @@ -2056,7 +2643,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieve an active entitlement

*/ + /** + * Retrieve an active entitlement + * @description

Retrieve an active entitlement

+ */ get: operations["GetEntitlementsActiveEntitlementsId"]; put?: never; post?: never; @@ -2073,10 +2663,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieve a list of features

*/ + /** + * List all features + * @description

Retrieve a list of features

+ */ get: operations["GetEntitlementsFeatures"]; put?: never; - /** @description

Creates a feature

*/ + /** + * Create a feature + * @description

Creates a feature

+ */ post: operations["PostEntitlementsFeatures"]; delete?: never; options?: never; @@ -2091,10 +2687,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a feature

*/ + /** + * Retrieve a feature + * @description

Retrieves a feature

+ */ get: operations["GetEntitlementsFeaturesId"]; put?: never; - /** @description

Update a feature’s metadata or permanently deactivate it.

*/ + /** + * Updates a feature + * @description

Update a feature’s metadata or permanently deactivate it.

+ */ post: operations["PostEntitlementsFeaturesId"]; delete?: never; options?: never; @@ -2111,7 +2713,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Creates a short-lived API key for a given resource.

*/ + /** + * Create an ephemeral key + * @description

Creates a short-lived API key for a given resource.

+ */ post: operations["PostEphemeralKeys"]; delete?: never; options?: never; @@ -2129,7 +2734,10 @@ export interface paths { get?: never; put?: never; post?: never; - /** @description

Invalidates a short-lived API key for a given resource.

*/ + /** + * Immediately invalidate an ephemeral key + * @description

Invalidates a short-lived API key for a given resource.

+ */ delete: operations["DeleteEphemeralKeysKey"]; options?: never; head?: never; @@ -2143,7 +2751,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @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).

*/ + /** + * List all events + * @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).

+ */ get: operations["GetEvents"]; put?: never; post?: never; @@ -2160,7 +2771,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.

*/ + /** + * Retrieve an event + * @description

Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.

+ */ get: operations["GetEventsId"]; put?: never; post?: never; @@ -2177,7 +2791,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * List all exchange rates + * @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.

+ */ get: operations["GetExchangeRates"]; put?: never; post?: never; @@ -2194,7 +2811,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the exchange rates from the given currency to every supported currency.

*/ + /** + * Retrieve an exchange rate + * @description

Retrieves the exchange rates from the given currency to every supported currency.

+ */ get: operations["GetExchangeRatesRateId"]; put?: never; post?: never; @@ -2211,10 +2831,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of file links.

*/ + /** + * List all file links + * @description

Returns a list of file links.

+ */ get: operations["GetFileLinks"]; put?: never; - /** @description

Creates a new file link object.

*/ + /** + * Create a file link + * @description

Creates a new file link object.

+ */ post: operations["PostFileLinks"]; delete?: never; options?: never; @@ -2229,10 +2855,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the file link with the given ID.

*/ + /** + * Retrieve a file link + * @description

Retrieves the file link with the given ID.

+ */ get: operations["GetFileLinksLink"]; put?: never; - /** @description

Updates an existing file link object. Expired links can no longer be updated.

*/ + /** + * Update a file link + * @description

Updates an existing file link object. Expired links can no longer be updated.

+ */ post: operations["PostFileLinksLink"]; delete?: never; options?: never; @@ -2247,12 +2879,18 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * List all files + * @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"]; put?: never; - /** @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.

+ /** + * Create 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 support sending multipart/form-data.

*/ + *

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

+ */ post: operations["PostFiles"]; delete?: never; options?: never; @@ -2267,7 +2905,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * Retrieve a file + * @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"]; put?: never; post?: never; @@ -2284,7 +2925,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of Financial Connections Account objects.

*/ + /** + * List Accounts + * @description

Returns a list of Financial Connections Account objects.

+ */ get: operations["GetFinancialConnectionsAccounts"]; put?: never; post?: never; @@ -2301,7 +2945,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of an Financial Connections Account.

*/ + /** + * Retrieve an Account + * @description

Retrieves the details of an Financial Connections Account.

+ */ get: operations["GetFinancialConnectionsAccountsAccount"]; put?: never; post?: never; @@ -2320,7 +2967,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

*/ + /** + * Disconnect an Account + * @description

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

+ */ post: operations["PostFinancialConnectionsAccountsAccountDisconnect"]; delete?: never; options?: never; @@ -2335,7 +2985,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Lists all owners for a given Account

*/ + /** + * List Account Owners + * @description

Lists all owners for a given Account

+ */ get: operations["GetFinancialConnectionsAccountsAccountOwners"]; put?: never; post?: never; @@ -2354,7 +3007,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Refreshes the data associated with a Financial Connections Account.

*/ + /** + * Refresh Account data + * @description

Refreshes the data associated with a Financial Connections Account.

+ */ post: operations["PostFinancialConnectionsAccountsAccountRefresh"]; delete?: never; options?: never; @@ -2371,7 +3027,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Subscribes to periodic refreshes of data associated with a Financial Connections Account.

*/ + /** + * Subscribe to data refreshes for an Account + * @description

Subscribes to periodic refreshes of data associated with a Financial Connections Account.

+ */ post: operations["PostFinancialConnectionsAccountsAccountSubscribe"]; delete?: never; options?: never; @@ -2388,7 +3047,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

*/ + /** + * Unsubscribe from data refreshes for an Account + * @description

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

+ */ post: operations["PostFinancialConnectionsAccountsAccountUnsubscribe"]; delete?: never; options?: never; @@ -2405,7 +3067,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

*/ + /** + * Create a Session + * @description

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

+ */ post: operations["PostFinancialConnectionsSessions"]; delete?: never; options?: never; @@ -2420,7 +3085,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of a Financial Connections Session

*/ + /** + * Retrieve a Session + * @description

Retrieves the details of a Financial Connections Session

+ */ get: operations["GetFinancialConnectionsSessionsSession"]; put?: never; post?: never; @@ -2437,7 +3105,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of Financial Connections Transaction objects.

*/ + /** + * List Transactions + * @description

Returns a list of Financial Connections Transaction objects.

+ */ get: operations["GetFinancialConnectionsTransactions"]; put?: never; post?: never; @@ -2454,7 +3125,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of a Financial Connections Transaction

*/ + /** + * Retrieve a Transaction + * @description

Retrieves the details of a Financial Connections Transaction

+ */ get: operations["GetFinancialConnectionsTransactionsTransaction"]; put?: never; post?: never; @@ -2471,10 +3145,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Lists all ForwardingRequest objects.

*/ + /** + * List all ForwardingRequests + * @description

Lists all ForwardingRequest objects.

+ */ get: operations["GetForwardingRequests"]; put?: never; - /** @description

Creates a ForwardingRequest object.

*/ + /** + * Create a ForwardingRequest + * @description

Creates a ForwardingRequest object.

+ */ post: operations["PostForwardingRequests"]; delete?: never; options?: never; @@ -2489,7 +3169,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a ForwardingRequest object.

*/ + /** + * Retrieve a ForwardingRequest + * @description

Retrieves a ForwardingRequest object.

+ */ get: operations["GetForwardingRequestsId"]; put?: never; post?: never; @@ -2506,7 +3189,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

List all verification reports.

*/ + /** + * List VerificationReports + * @description

List all verification reports.

+ */ get: operations["GetIdentityVerificationReports"]; put?: never; post?: never; @@ -2523,7 +3209,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves an existing VerificationReport

*/ + /** + * Retrieve a VerificationReport + * @description

Retrieves an existing VerificationReport

+ */ get: operations["GetIdentityVerificationReportsReport"]; put?: never; post?: never; @@ -2540,16 +3229,22 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of VerificationSessions

*/ + /** + * List VerificationSessions + * @description

Returns a list of VerificationSessions

+ */ get: operations["GetIdentityVerificationSessions"]; put?: never; - /** @description

Creates a VerificationSession object.

+ /** + * Create a VerificationSession + * @description

Creates a VerificationSession object.

* *

After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session’s url.

* *

If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.

* - *

Related guide: Verify your users’ identity documents

*/ + *

Related guide: Verify your users’ identity documents

+ */ post: operations["PostIdentityVerificationSessions"]; delete?: never; options?: never; @@ -2564,16 +3259,22 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of a VerificationSession that was previously created.

+ /** + * Retrieve a VerificationSession + * @description

Retrieves the details of a VerificationSession that was previously created.

* *

When the session status is requires_input, you can use this method to retrieve a valid - * client_secret or url to allow re-submission.

*/ + * client_secret or url to allow re-submission.

+ */ get: operations["GetIdentityVerificationSessionsSession"]; put?: never; - /** @description

Updates a VerificationSession object.

+ /** + * Update a VerificationSession + * @description

Updates a VerificationSession object.

* *

When the session status is requires_input, you can use this method to update the - * verification check and options.

*/ + * verification check and options.

+ */ post: operations["PostIdentityVerificationSessionsSession"]; delete?: never; options?: never; @@ -2590,9 +3291,12 @@ export interface paths { }; get?: never; put?: never; - /** @description

A VerificationSession object can be canceled when it is in requires_input status.

+ /** + * Cancel a VerificationSession + * @description

A VerificationSession object can be canceled when it is in requires_input status.

* - *

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

*/ + *

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

+ */ post: operations["PostIdentityVerificationSessionsSessionCancel"]; delete?: never; options?: never; @@ -2609,7 +3313,9 @@ export interface paths { }; get?: never; put?: never; - /** @description

Redact a VerificationSession to remove all collected information from Stripe. This will redact + /** + * Redact a VerificationSession + * @description

Redact a VerificationSession to remove all collected information from Stripe. This will redact * the VerificationSession and all objects related to it, including VerificationReports, Events, * request logs, etc.

* @@ -2627,7 +3333,8 @@ export interface paths { * placeholder. The metadata field will also be erased. Redacted objects cannot be updated or * used for any purpose.

* - *

Learn more.

*/ + *

Learn more.

+ */ post: operations["PostIdentityVerificationSessionsSessionRedact"]; delete?: never; options?: never; @@ -2642,7 +3349,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

List all templates, ordered by creation date, with the most recently created template appearing first.

*/ + /** + * List all invoice rendering templates + * @description

List all templates, ordered by creation date, with the most recently created template appearing first.

+ */ get: operations["GetInvoiceRenderingTemplates"]; put?: never; post?: never; @@ -2659,7 +3369,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

*/ + /** + * Retrieve an invoice rendering template + * @description

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

+ */ get: operations["GetInvoiceRenderingTemplatesTemplate"]; put?: never; post?: never; @@ -2678,7 +3391,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

*/ + /** + * Archive an invoice rendering template + * @description

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

+ */ post: operations["PostInvoiceRenderingTemplatesTemplateArchive"]; delete?: never; options?: never; @@ -2695,7 +3411,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

*/ + /** + * Unarchive an invoice rendering template + * @description

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

+ */ post: operations["PostInvoiceRenderingTemplatesTemplateUnarchive"]; delete?: never; options?: never; @@ -2710,10 +3429,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * List all invoice items + * @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.

+ */ get: operations["GetInvoiceitems"]; put?: never; - /** @description

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

*/ + /** + * Create an invoice item + * @description

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

+ */ post: operations["PostInvoiceitems"]; delete?: never; options?: never; @@ -2728,12 +3453,21 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the invoice item with the given ID.

*/ + /** + * Retrieve an invoice item + * @description

Retrieves the invoice item with the given ID.

+ */ get: operations["GetInvoiceitemsInvoiceitem"]; put?: never; - /** @description

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

*/ + /** + * Update an invoice item + * @description

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

+ */ post: operations["PostInvoiceitemsInvoiceitem"]; - /** @description

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

*/ + /** + * Delete an invoice item + * @description

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

+ */ delete: operations["DeleteInvoiceitemsInvoiceitem"]; options?: never; head?: never; @@ -2747,10 +3481,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * List all invoices + * @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.

+ */ get: operations["GetInvoices"]; put?: never; - /** @description

This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

*/ + /** + * Create an invoice + * @description

This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

+ */ post: operations["PostInvoices"]; delete?: never; options?: never; @@ -2767,13 +3507,16 @@ export interface paths { }; get?: never; put?: never; - /** @description

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

+ /** + * Create a preview invoice + * @description

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

* *

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

* *

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.

* - *

Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. Learn more

*/ + *

Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. Learn more

+ */ post: operations["PostInvoicesCreatePreview"]; delete?: never; options?: never; @@ -2788,10 +3531,13 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Search for invoices you’ve previously created using Stripe’s Search Query Language. + /** + * Search invoices + * @description

Search for invoices you’ve previously created using Stripe’s Search Query Language. * Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up - * to an hour behind during outages. Search functionality is not available to merchants in India.

*/ + * to an hour behind during outages. Search functionality is not available to merchants in India.

+ */ get: operations["GetInvoicesSearch"]; put?: never; post?: never; @@ -2808,13 +3554,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

+ /** + * Retrieve an upcoming invoice + * @description

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

* *

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

* *

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.

* - *

Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. Learn more

*/ + *

Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. Learn more

+ */ get: operations["GetInvoicesUpcoming"]; put?: never; post?: never; @@ -2831,7 +3580,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * Retrieve an upcoming invoice's line items + * @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.

+ */ get: operations["GetInvoicesUpcomingLines"]; put?: never; post?: never; @@ -2848,17 +3600,26 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the invoice with the given ID.

*/ + /** + * Retrieve an invoice + * @description

Retrieves the invoice with the given ID.

+ */ get: operations["GetInvoicesInvoice"]; put?: never; - /** @description

Draft invoices are fully editable. Once an invoice is finalized, + /** + * Update an invoice + * @description

Draft invoices are fully editable. Once an invoice is finalized, * monetary values, as well as collection_method, become uneditable.

* *

If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, * sending reminders for, or automatically reconciling invoices, pass - * auto_advance=false.

*/ + * auto_advance=false.

+ */ post: operations["PostInvoicesInvoice"]; - /** @description

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.

*/ + /** + * Delete a draft invoice + * @description

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.

+ */ delete: operations["DeleteInvoicesInvoice"]; options?: never; head?: never; @@ -2874,7 +3635,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.

*/ + /** + * Bulk add invoice line items + * @description

Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.

+ */ post: operations["PostInvoicesInvoiceAddLines"]; delete?: never; options?: never; @@ -2891,7 +3655,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

*/ + /** + * Finalize an invoice + * @description

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

+ */ post: operations["PostInvoicesInvoiceFinalize"]; delete?: never; options?: never; @@ -2906,7 +3673,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

When retrieving an 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.

*/ + /** + * Retrieve an invoice's line items + * @description

When retrieving an 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.

+ */ get: operations["GetInvoicesInvoiceLines"]; put?: never; post?: never; @@ -2925,10 +3695,13 @@ export interface paths { }; get?: never; put?: never; - /** @description

Updates an invoice’s line item. Some fields, such as tax_amounts, only live on the invoice line item, + /** + * Update an invoice's line item + * @description

Updates an invoice’s line item. Some fields, such as tax_amounts, only live on the invoice line item, * so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice * item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well. - * Updating an invoice’s line item is only possible before the invoice is finalized.

*/ + * Updating an invoice’s line item is only possible before the invoice is finalized.

+ */ post: operations["PostInvoicesInvoiceLinesLineItemId"]; delete?: never; options?: never; @@ -2945,7 +3718,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

*/ + /** + * Mark an invoice as uncollectible + * @description

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

+ */ post: operations["PostInvoicesInvoiceMarkUncollectible"]; delete?: never; options?: never; @@ -2962,7 +3738,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

*/ + /** + * Pay an invoice + * @description

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

+ */ post: operations["PostInvoicesInvoicePay"]; delete?: never; options?: never; @@ -2979,7 +3758,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.

*/ + /** + * Bulk remove invoice line items + * @description

Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.

+ */ post: operations["PostInvoicesInvoiceRemoveLines"]; delete?: never; options?: never; @@ -2996,9 +3778,12 @@ export interface paths { }; get?: never; put?: never; - /** @description

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

+ /** + * Send an invoice for manual payment + * @description

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

* - *

Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

*/ + *

Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

+ */ post: operations["PostInvoicesInvoiceSend"]; delete?: never; options?: never; @@ -3015,7 +3800,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.

*/ + /** + * Bulk update invoice line items + * @description

Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.

+ */ post: operations["PostInvoicesInvoiceUpdateLines"]; delete?: never; options?: never; @@ -3032,9 +3820,12 @@ export interface paths { }; get?: never; put?: never; - /** @description

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

+ /** + * Void an invoice + * @description

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

* - *

Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to issue another invoice or credit note instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.

*/ + *

Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to issue another invoice or credit note instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.

+ */ post: operations["PostInvoicesInvoiceVoid"]; delete?: never; options?: never; @@ -3049,7 +3840,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * List all authorizations + * @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.

+ */ get: operations["GetIssuingAuthorizations"]; put?: never; post?: never; @@ -3066,10 +3860,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves an Issuing Authorization object.

*/ + /** + * Retrieve an authorization + * @description

Retrieves an Issuing Authorization object.

+ */ get: operations["GetIssuingAuthorizationsAuthorization"]; put?: never; - /** @description

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ + /** + * Update an authorization + * @description

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ post: operations["PostIssuingAuthorizationsAuthorization"]; delete?: never; options?: never; @@ -3087,6 +3887,7 @@ export interface paths { get?: never; put?: never; /** + * Approve an authorization * @deprecated * @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.

@@ -3108,6 +3909,7 @@ export interface paths { get?: never; put?: never; /** + * Decline an authorization * @deprecated * @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.

@@ -3126,10 +3928,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * List all cardholders + * @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.

+ */ get: operations["GetIssuingCardholders"]; put?: never; - /** @description

Creates a new Issuing Cardholder object that can be issued cards.

*/ + /** + * Create a cardholder + * @description

Creates a new Issuing Cardholder object that can be issued cards.

+ */ post: operations["PostIssuingCardholders"]; delete?: never; options?: never; @@ -3144,10 +3952,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves an Issuing Cardholder object.

*/ + /** + * Retrieve a cardholder + * @description

Retrieves an Issuing Cardholder object.

+ */ get: operations["GetIssuingCardholdersCardholder"]; put?: never; - /** @description

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ + /** + * Update a cardholder + * @description

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ post: operations["PostIssuingCardholdersCardholder"]; delete?: never; options?: never; @@ -3162,10 +3976,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * List all cards + * @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.

+ */ get: operations["GetIssuingCards"]; put?: never; - /** @description

Creates an Issuing Card object.

*/ + /** + * Create a card + * @description

Creates an Issuing Card object.

+ */ post: operations["PostIssuingCards"]; delete?: never; options?: never; @@ -3180,10 +4000,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves an Issuing Card object.

*/ + /** + * Retrieve a card + * @description

Retrieves an Issuing Card object.

+ */ get: operations["GetIssuingCardsCard"]; put?: never; - /** @description

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ + /** + * Update a card + * @description

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ post: operations["PostIssuingCardsCard"]; delete?: never; options?: never; @@ -3198,10 +4024,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * List all disputes + * @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.

+ */ get: operations["GetIssuingDisputes"]; put?: never; - /** @description

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

*/ + /** + * Create a dispute + * @description

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

+ */ post: operations["PostIssuingDisputes"]; delete?: never; options?: never; @@ -3216,10 +4048,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves an Issuing Dispute object.

*/ + /** + * Retrieve a dispute + * @description

Retrieves an Issuing Dispute object.

+ */ get: operations["GetIssuingDisputesDispute"]; put?: never; - /** @description

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

*/ + /** + * Update a dispute + * @description

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

+ */ post: operations["PostIssuingDisputesDispute"]; delete?: never; options?: never; @@ -3236,7 +4074,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

*/ + /** + * Submit a dispute + * @description

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

+ */ post: operations["PostIssuingDisputesDisputeSubmit"]; delete?: never; options?: never; @@ -3251,10 +4092,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

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

*/ + /** + * List all personalization designs + * @description

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

+ */ get: operations["GetIssuingPersonalizationDesigns"]; put?: never; - /** @description

Creates a personalization design object.

*/ + /** + * Create a personalization design + * @description

Creates a personalization design object.

+ */ post: operations["PostIssuingPersonalizationDesigns"]; delete?: never; options?: never; @@ -3269,10 +4116,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a personalization design object.

*/ + /** + * Retrieve a personalization design + * @description

Retrieves a personalization design object.

+ */ get: operations["GetIssuingPersonalizationDesignsPersonalizationDesign"]; put?: never; - /** @description

Updates a card personalization object.

*/ + /** + * Update a personalization design + * @description

Updates a card personalization object.

+ */ post: operations["PostIssuingPersonalizationDesignsPersonalizationDesign"]; delete?: never; options?: never; @@ -3287,7 +4140,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

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

*/ + /** + * List all physical bundles + * @description

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

+ */ get: operations["GetIssuingPhysicalBundles"]; put?: never; post?: never; @@ -3304,7 +4160,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a physical bundle object.

*/ + /** + * Retrieve a physical bundle + * @description

Retrieves a physical bundle object.

+ */ get: operations["GetIssuingPhysicalBundlesPhysicalBundle"]; put?: never; post?: never; @@ -3321,10 +4180,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves an Issuing Settlement object.

*/ + /** + * Retrieve a settlement + * @description

Retrieves an Issuing Settlement object.

+ */ get: operations["GetIssuingSettlementsSettlement"]; put?: never; - /** @description

Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ + /** + * Update a settlement + * @description

Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ post: operations["PostIssuingSettlementsSettlement"]; delete?: never; options?: never; @@ -3339,7 +4204,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Lists all Issuing Token objects for a given card.

*/ + /** + * List all issuing tokens for card + * @description

Lists all Issuing Token objects for a given card.

+ */ get: operations["GetIssuingTokens"]; put?: never; post?: never; @@ -3356,10 +4224,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves an Issuing Token object.

*/ + /** + * Retrieve an issuing token + * @description

Retrieves an Issuing Token object.

+ */ get: operations["GetIssuingTokensToken"]; put?: never; - /** @description

Attempts to update the specified Issuing Token object to the status specified.

*/ + /** + * Update a token status + * @description

Attempts to update the specified Issuing Token object to the status specified.

+ */ post: operations["PostIssuingTokensToken"]; delete?: never; options?: never; @@ -3374,7 +4248,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * List all transactions + * @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.

+ */ get: operations["GetIssuingTransactions"]; put?: never; post?: never; @@ -3391,10 +4268,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves an Issuing Transaction object.

*/ + /** + * Retrieve a transaction + * @description

Retrieves an Issuing Transaction object.

+ */ get: operations["GetIssuingTransactionsTransaction"]; put?: never; - /** @description

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ + /** + * Update a transaction + * @description

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ post: operations["PostIssuingTransactionsTransaction"]; delete?: never; options?: never; @@ -3411,7 +4294,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

*/ + /** + * Create a Session + * @description

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

+ */ post: operations["PostLinkAccountSessions"]; delete?: never; options?: never; @@ -3426,7 +4312,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of a Financial Connections Session

*/ + /** + * Retrieve a Session + * @description

Retrieves the details of a Financial Connections Session

+ */ get: operations["GetLinkAccountSessionsSession"]; put?: never; post?: never; @@ -3443,7 +4332,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of Financial Connections Account objects.

*/ + /** + * List Accounts + * @description

Returns a list of Financial Connections Account objects.

+ */ get: operations["GetLinkedAccounts"]; put?: never; post?: never; @@ -3460,7 +4352,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of an Financial Connections Account.

*/ + /** + * Retrieve an Account + * @description

Retrieves the details of an Financial Connections Account.

+ */ get: operations["GetLinkedAccountsAccount"]; put?: never; post?: never; @@ -3479,7 +4374,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

*/ + /** + * Disconnect an Account + * @description

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

+ */ post: operations["PostLinkedAccountsAccountDisconnect"]; delete?: never; options?: never; @@ -3494,7 +4392,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Lists all owners for a given Account

*/ + /** + * List Account Owners + * @description

Lists all owners for a given Account

+ */ get: operations["GetLinkedAccountsAccountOwners"]; put?: never; post?: never; @@ -3513,7 +4414,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Refreshes the data associated with a Financial Connections Account.

*/ + /** + * Refresh Account data + * @description

Refreshes the data associated with a Financial Connections Account.

+ */ post: operations["PostLinkedAccountsAccountRefresh"]; delete?: never; options?: never; @@ -3528,7 +4432,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a Mandate object.

*/ + /** + * Retrieve a Mandate + * @description

Retrieves a Mandate object.

+ */ get: operations["GetMandatesMandate"]; put?: never; post?: never; @@ -3545,10 +4452,15 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of PaymentIntents.

*/ + /** + * List all PaymentIntents + * @description

Returns a list of PaymentIntents.

+ */ get: operations["GetPaymentIntents"]; put?: never; - /** @description

Creates a PaymentIntent object.

+ /** + * Create a PaymentIntent + * @description

Creates a PaymentIntent object.

* *

After the PaymentIntent is created, attach a payment method and confirm * to continue the payment. Learn more about the available payment flows @@ -3557,7 +4469,8 @@ export interface paths { *

When you use confirm=true during creation, it’s equivalent to creating * and confirming the PaymentIntent in the same call. You can use any parameters * available in the confirm API when you supply - * confirm=true.

*/ + * confirm=true.

+ */ post: operations["PostPaymentIntents"]; delete?: never; options?: never; @@ -3572,10 +4485,13 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language. + /** + * Search PaymentIntents + * @description

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language. * Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up - * to an hour behind during outages. Search functionality is not available to merchants in India.

*/ + * to an hour behind during outages. Search functionality is not available to merchants in India.

+ */ get: operations["GetPaymentIntentsSearch"]; put?: never; post?: never; @@ -3592,20 +4508,26 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of a PaymentIntent that has previously been created.

+ /** + * Retrieve a PaymentIntent + * @description

Retrieves the details of a PaymentIntent that has previously been created.

* *

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

* - *

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

*/ + *

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

+ */ get: operations["GetPaymentIntentsIntent"]; put?: never; - /** @description

Updates properties on a PaymentIntent object without confirming.

+ /** + * Update a PaymentIntent + * @description

Updates properties on a PaymentIntent object without confirming.

* *

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.

*/ + * the confirm API instead.

+ */ post: operations["PostPaymentIntentsIntent"]; delete?: never; options?: never; @@ -3622,7 +4544,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

*/ + /** + * Reconcile a customer_balance PaymentIntent + * @description

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

+ */ post: operations["PostPaymentIntentsIntentApplyCustomerBalance"]; delete?: never; options?: never; @@ -3639,11 +4564,14 @@ export interface paths { }; get?: never; put?: never; - /** @description

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

+ /** + * Cancel a PaymentIntent + * @description

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

* *

After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.

* - *

You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

*/ + *

You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

+ */ post: operations["PostPaymentIntentsIntentCancel"]; delete?: never; options?: never; @@ -3660,11 +4588,14 @@ export interface paths { }; get?: never; put?: never; - /** @description

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

+ /** + * Capture a PaymentIntent + * @description

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

* *

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

* - *

Learn more about separate authorization and capture.

*/ + *

Learn more about separate authorization and capture.

+ */ post: operations["PostPaymentIntentsIntentCapture"]; delete?: never; options?: never; @@ -3681,7 +4612,9 @@ export interface paths { }; get?: never; put?: never; - /** @description

Confirm that your customer intends to pay with current or provided + /** + * Confirm a PaymentIntent + * @description

Confirm that your customer intends to pay with current or provided * payment method. Upon confirmation, the PaymentIntent will attempt to initiate * a payment. * If the selected payment method requires additional authentication steps, the @@ -3705,7 +4638,8 @@ export interface paths { * attempt. * There is a variable upper limit on how many times a PaymentIntent can be confirmed. * After this limit is reached, any further calls to this endpoint will - * transition the PaymentIntent to the canceled state.

*/ + * transition the PaymentIntent to the canceled state.

+ */ post: operations["PostPaymentIntentsIntentConfirm"]; delete?: never; options?: never; @@ -3722,7 +4656,9 @@ export interface paths { }; get?: never; put?: never; - /** @description

Perform an incremental authorization on an eligible + /** + * Increment an authorization + * @description

Perform an incremental authorization on an eligible * PaymentIntent. To be eligible, the * PaymentIntent’s status must be requires_capture and * incremental_authorization_supported @@ -3745,7 +4681,8 @@ export interface paths { *

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. * After it’s captured, a PaymentIntent can no longer be incremented.

* - *

Learn more about incremental authorizations.

*/ + *

Learn more about incremental authorizations.

+ */ post: operations["PostPaymentIntentsIntentIncrementAuthorization"]; delete?: never; options?: never; @@ -3762,7 +4699,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Verifies microdeposits on a PaymentIntent object.

*/ + /** + * Verify microdeposits on a PaymentIntent + * @description

Verifies microdeposits on a PaymentIntent object.

+ */ post: operations["PostPaymentIntentsIntentVerifyMicrodeposits"]; delete?: never; options?: never; @@ -3777,10 +4717,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of your payment links.

*/ + /** + * List all payment links + * @description

Returns a list of your payment links.

+ */ get: operations["GetPaymentLinks"]; put?: never; - /** @description

Creates a payment link.

*/ + /** + * Create a payment link + * @description

Creates a payment link.

+ */ post: operations["PostPaymentLinks"]; delete?: never; options?: never; @@ -3795,10 +4741,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieve a payment link.

*/ + /** + * Retrieve payment link + * @description

Retrieve a payment link.

+ */ get: operations["GetPaymentLinksPaymentLink"]; put?: never; - /** @description

Updates a payment link.

*/ + /** + * Update a payment link + * @description

Updates a payment link.

+ */ post: operations["PostPaymentLinksPaymentLink"]; delete?: never; options?: never; @@ -3813,7 +4765,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * Retrieve a payment link's line items + * @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"]; put?: never; post?: never; @@ -3830,10 +4785,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

List payment method configurations

*/ + /** + * List payment method configurations + * @description

List payment method configurations

+ */ get: operations["GetPaymentMethodConfigurations"]; put?: never; - /** @description

Creates a payment method configuration

*/ + /** + * Create a payment method configuration + * @description

Creates a payment method configuration

+ */ post: operations["PostPaymentMethodConfigurations"]; delete?: never; options?: never; @@ -3848,10 +4809,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieve payment method configuration

*/ + /** + * Retrieve payment method configuration + * @description

Retrieve payment method configuration

+ */ get: operations["GetPaymentMethodConfigurationsConfiguration"]; put?: never; - /** @description

Update payment method configuration

*/ + /** + * Update payment method configuration + * @description

Update payment method configuration

+ */ post: operations["PostPaymentMethodConfigurationsConfiguration"]; delete?: never; options?: never; @@ -3866,10 +4833,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Lists the details of existing payment method domains.

*/ + /** + * List payment method domains + * @description

Lists the details of existing payment method domains.

+ */ get: operations["GetPaymentMethodDomains"]; put?: never; - /** @description

Creates a payment method domain.

*/ + /** + * Create a payment method domain + * @description

Creates a payment method domain.

+ */ post: operations["PostPaymentMethodDomains"]; delete?: never; options?: never; @@ -3884,10 +4857,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of an existing payment method domain.

*/ + /** + * Retrieve a payment method domain + * @description

Retrieves the details of an existing payment method domain.

+ */ get: operations["GetPaymentMethodDomainsPaymentMethodDomain"]; put?: never; - /** @description

Updates an existing payment method domain.

*/ + /** + * Update a payment method domain + * @description

Updates an existing payment method domain.

+ */ post: operations["PostPaymentMethodDomainsPaymentMethodDomain"]; delete?: never; options?: never; @@ -3904,12 +4883,15 @@ export interface paths { }; get?: never; put?: never; - /** @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. + /** + * Validate an existing payment method domain + * @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.

*/ + *

Related guides: Payment method domains.

+ */ post: operations["PostPaymentMethodDomainsPaymentMethodDomainValidate"]; delete?: never; options?: never; @@ -3924,12 +4906,18 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * List PaymentMethods + * @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.

+ */ get: operations["GetPaymentMethods"]; put?: never; - /** @description

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

+ /** + * Shares a PaymentMethod + * @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.

*/ + *

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.

+ */ post: operations["PostPaymentMethods"]; delete?: never; options?: never; @@ -3944,10 +4932,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

*/ + /** + * Retrieve a PaymentMethod + * @description

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

+ */ get: operations["GetPaymentMethodsPaymentMethod"]; put?: never; - /** @description

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

*/ + /** + * Update a PaymentMethod + * @description

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

+ */ post: operations["PostPaymentMethodsPaymentMethod"]; delete?: never; options?: never; @@ -3964,7 +4958,9 @@ export interface paths { }; get?: never; put?: never; - /** @description

Attaches a PaymentMethod object to a Customer.

+ /** + * Attach a PaymentMethod to a Customer + * @description

Attaches a PaymentMethod object to a Customer.

* *

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent * or a PaymentIntent with setup_future_usage. @@ -3976,7 +4972,8 @@ export interface paths { * *

To use this PaymentMethod as the default for invoice or subscription payments, * set invoice_settings.default_payment_method, - * on the Customer to the PaymentMethod’s ID.

*/ + * on the Customer to the PaymentMethod’s ID.

+ */ post: operations["PostPaymentMethodsPaymentMethodAttach"]; delete?: never; options?: never; @@ -3993,7 +4990,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

*/ + /** + * Detach a PaymentMethod from a Customer + * @description

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

+ */ post: operations["PostPaymentMethodsPaymentMethodDetach"]; delete?: never; options?: never; @@ -4008,14 +5008,20 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

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

*/ + /** + * List all payouts + * @description

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

+ */ get: operations["GetPayouts"]; put?: never; - /** @description

To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.

+ /** + * Create a payout + * @description

To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.

* *

If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.

* - *

If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The balance object details available and pending amounts by source type.

*/ + *

If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The balance object details available and pending amounts by source type.

+ */ post: operations["PostPayouts"]; delete?: never; options?: never; @@ -4030,10 +5036,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

*/ + /** + * Retrieve a payout + * @description

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

+ */ get: operations["GetPayoutsPayout"]; put?: never; - /** @description

Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.

*/ + /** + * Update a payout + * @description

Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.

+ */ post: operations["PostPayoutsPayout"]; delete?: never; options?: never; @@ -4050,7 +5062,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

*/ + /** + * Cancel a payout + * @description

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

+ */ post: operations["PostPayoutsPayoutCancel"]; delete?: never; options?: never; @@ -4067,9 +5082,12 @@ export interface paths { }; get?: never; put?: never; - /** @description

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.

+ /** + * Reverse a payout + * @description

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.

* - *

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

*/ + *

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

+ */ post: operations["PostPayoutsPayoutReverse"]; delete?: never; options?: never; @@ -4084,10 +5102,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of your plans.

*/ + /** + * List all plans + * @description

Returns a list of your plans.

+ */ get: operations["GetPlans"]; put?: never; - /** @description

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

*/ + /** + * Create a plan + * @description

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

+ */ post: operations["PostPlans"]; delete?: never; options?: never; @@ -4102,12 +5126,21 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the plan with the given ID.

*/ + /** + * Retrieve a plan + * @description

Retrieves the plan with the given ID.

+ */ get: operations["GetPlansPlan"]; put?: never; - /** @description

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

*/ + /** + * Update a plan + * @description

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

+ */ post: operations["PostPlansPlan"]; - /** @description

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

*/ + /** + * Delete a plan + * @description

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

+ */ delete: operations["DeletePlansPlan"]; options?: never; head?: never; @@ -4121,10 +5154,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

*/ + /** + * List all prices + * @description

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

+ */ get: operations["GetPrices"]; put?: never; - /** @description

Creates a new price for an existing product. The price can be recurring or one-time.

*/ + /** + * Create a price + * @description

Creates a new price for an existing product. The price can be recurring or one-time.

+ */ post: operations["PostPrices"]; delete?: never; options?: never; @@ -4139,10 +5178,13 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Search for prices you’ve previously created using Stripe’s Search Query Language. + /** + * Search prices + * @description

Search for prices you’ve previously created using Stripe’s Search Query Language. * Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up - * to an hour behind during outages. Search functionality is not available to merchants in India.

*/ + * to an hour behind during outages. Search functionality is not available to merchants in India.

+ */ get: operations["GetPricesSearch"]; put?: never; post?: never; @@ -4159,10 +5201,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the price with the given ID.

*/ + /** + * Retrieve a price + * @description

Retrieves the price with the given ID.

+ */ get: operations["GetPricesPrice"]; put?: never; - /** @description

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

*/ + /** + * Update a price + * @description

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

+ */ post: operations["PostPricesPrice"]; delete?: never; options?: never; @@ -4177,10 +5225,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

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

*/ + /** + * List all products + * @description

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

+ */ get: operations["GetProducts"]; put?: never; - /** @description

Creates a new product object.

*/ + /** + * Create a product + * @description

Creates a new product object.

+ */ post: operations["PostProducts"]; delete?: never; options?: never; @@ -4195,10 +5249,13 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Search for products you’ve previously created using Stripe’s Search Query Language. + /** + * Search products + * @description

Search for products you’ve previously created using Stripe’s Search Query Language. * Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up - * to an hour behind during outages. Search functionality is not available to merchants in India.

*/ + * to an hour behind during outages. Search functionality is not available to merchants in India.

+ */ get: operations["GetProductsSearch"]; put?: never; post?: never; @@ -4215,12 +5272,21 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

*/ + /** + * Retrieve a product + * @description

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

+ */ get: operations["GetProductsId"]; put?: never; - /** @description

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

*/ + /** + * Update a product + * @description

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ post: operations["PostProductsId"]; - /** @description

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

*/ + /** + * Delete a product + * @description

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

+ */ delete: operations["DeleteProductsId"]; options?: never; head?: never; @@ -4234,10 +5300,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieve a list of features for a product

*/ + /** + * List all features attached to a product + * @description

Retrieve a list of features for a product

+ */ get: operations["GetProductsProductFeatures"]; put?: never; - /** @description

Creates a product_feature, which represents a feature attachment to a product

*/ + /** + * Attach a feature to a product + * @description

Creates a product_feature, which represents a feature attachment to a product

+ */ post: operations["PostProductsProductFeatures"]; delete?: never; options?: never; @@ -4252,11 +5324,17 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a product_feature, which represents a feature attachment to a product

*/ + /** + * Retrieve a product_feature + * @description

Retrieves a product_feature, which represents a feature attachment to a product

+ */ get: operations["GetProductsProductFeaturesId"]; put?: never; post?: never; - /** @description

Deletes the feature attachment to a product

*/ + /** + * Remove a feature from a product + * @description

Deletes the feature attachment to a product

+ */ delete: operations["DeleteProductsProductFeaturesId"]; options?: never; head?: never; @@ -4270,10 +5348,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of your promotion codes.

*/ + /** + * List all promotion codes + * @description

Returns a list of your promotion codes.

+ */ get: operations["GetPromotionCodes"]; put?: never; - /** @description

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

*/ + /** + * Create a promotion code + * @description

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

+ */ post: operations["PostPromotionCodes"]; delete?: never; options?: never; @@ -4288,10 +5372,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code.

*/ + /** + * Retrieve a promotion code + * @description

Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code.

+ */ get: operations["GetPromotionCodesPromotionCode"]; put?: never; - /** @description

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

*/ + /** + * Update a promotion code + * @description

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

+ */ post: operations["PostPromotionCodesPromotionCode"]; delete?: never; options?: never; @@ -4306,10 +5396,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of your quotes.

*/ + /** + * List all quotes + * @description

Returns a list of your quotes.

+ */ get: operations["GetQuotes"]; put?: never; - /** @description

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

*/ + /** + * Create a quote + * @description

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

+ */ post: operations["PostQuotes"]; delete?: never; options?: never; @@ -4324,10 +5420,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the quote with the given ID.

*/ + /** + * Retrieve a quote + * @description

Retrieves the quote with the given ID.

+ */ get: operations["GetQuotesQuote"]; put?: never; - /** @description

A quote models prices and services for a customer.

*/ + /** + * Update a quote + * @description

A quote models prices and services for a customer.

+ */ post: operations["PostQuotesQuote"]; delete?: never; options?: never; @@ -4344,7 +5446,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Accepts the specified quote.

*/ + /** + * Accept a quote + * @description

Accepts the specified quote.

+ */ post: operations["PostQuotesQuoteAccept"]; delete?: never; options?: never; @@ -4361,7 +5466,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Cancels the quote.

*/ + /** + * Cancel a quote + * @description

Cancels the quote.

+ */ post: operations["PostQuotesQuoteCancel"]; delete?: never; options?: never; @@ -4376,7 +5484,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

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

*/ + /** + * Retrieve a quote's upfront line items + * @description

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

+ */ get: operations["GetQuotesQuoteComputedUpfrontLineItems"]; put?: never; post?: never; @@ -4395,7 +5506,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Finalizes the quote.

*/ + /** + * Finalize a quote + * @description

Finalizes the quote.

+ */ post: operations["PostQuotesQuoteFinalize"]; delete?: never; options?: never; @@ -4410,7 +5524,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

When retrieving a quote, 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.

*/ + /** + * Retrieve a quote's line items + * @description

When retrieving a quote, 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["GetQuotesQuoteLineItems"]; put?: never; post?: never; @@ -4427,7 +5544,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Download the PDF for a finalized quote. Explanation for special handling can be found here

*/ + /** + * Download quote PDF + * @description

Download the PDF for a finalized quote. Explanation for special handling can be found here

+ */ get: operations["GetQuotesQuotePdf"]; put?: never; post?: never; @@ -4444,7 +5564,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of early fraud warnings.

*/ + /** + * List all early fraud warnings + * @description

Returns a list of early fraud warnings.

+ */ get: operations["GetRadarEarlyFraudWarnings"]; put?: never; post?: never; @@ -4461,9 +5584,12 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of an early fraud warning that has previously been created.

+ /** + * Retrieve an early fraud warning + * @description

Retrieves the details of an early fraud warning that has previously been created.

* - *

Please refer to the early fraud warning object reference for more details.

*/ + *

Please refer to the early fraud warning object reference for more details.

+ */ get: operations["GetRadarEarlyFraudWarningsEarlyFraudWarning"]; put?: never; post?: never; @@ -4480,10 +5606,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

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

*/ + /** + * List all value list items + * @description

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

+ */ get: operations["GetRadarValueListItems"]; put?: never; - /** @description

Creates a new ValueListItem object, which is added to the specified parent value list.

*/ + /** + * Create a value list item + * @description

Creates a new ValueListItem object, which is added to the specified parent value list.

+ */ post: operations["PostRadarValueListItems"]; delete?: never; options?: never; @@ -4498,11 +5630,17 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a ValueListItem object.

*/ + /** + * Retrieve a value list item + * @description

Retrieves a ValueListItem object.

+ */ get: operations["GetRadarValueListItemsItem"]; put?: never; post?: never; - /** @description

Deletes a ValueListItem object, removing it from its parent value list.

*/ + /** + * Delete a value list item + * @description

Deletes a ValueListItem object, removing it from its parent value list.

+ */ delete: operations["DeleteRadarValueListItemsItem"]; options?: never; head?: never; @@ -4516,10 +5654,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * List all value lists + * @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.

+ */ get: operations["GetRadarValueLists"]; put?: never; - /** @description

Creates a new ValueList object, which can then be referenced in rules.

*/ + /** + * Create a value list + * @description

Creates a new ValueList object, which can then be referenced in rules.

+ */ post: operations["PostRadarValueLists"]; delete?: never; options?: never; @@ -4534,12 +5678,21 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a ValueList object.

*/ + /** + * Retrieve a value list + * @description

Retrieves a ValueList object.

+ */ get: operations["GetRadarValueListsValueList"]; put?: never; - /** @description

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

*/ + /** + * Update a value list + * @description

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

+ */ post: operations["PostRadarValueListsValueList"]; - /** @description

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

*/ + /** + * Delete a value list + * @description

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

+ */ delete: operations["DeleteRadarValueListsValueList"]; options?: never; head?: never; @@ -4553,10 +5706,15 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.

*/ + /** + * List all refunds + * @description

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.

+ */ get: operations["GetRefunds"]; put?: never; - /** @description

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

+ /** + * Create customer balance refund + * @description

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

* *

Creating a new refund will refund a charge that has previously been created but not yet refunded. * Funds will be refunded to the credit or debit card that was originally charged.

@@ -4566,7 +5724,8 @@ export interface paths { * *

Once entirely refunded, a charge can’t be refunded again. * This method will raise an error when called on an already-refunded charge, - * or when trying to refund more money than is left on a charge.

*/ + * or when trying to refund more money than is left on a charge.

+ */ post: operations["PostRefunds"]; delete?: never; options?: never; @@ -4581,12 +5740,18 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of an existing refund.

*/ + /** + * Retrieve a refund + * @description

Retrieves the details of an existing refund.

+ */ get: operations["GetRefundsRefund"]; put?: never; - /** @description

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

+ /** + * Update a refund + * @description

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

* - *

This request only accepts metadata as an argument.

*/ + *

This request only accepts metadata as an argument.

+ */ post: operations["PostRefundsRefund"]; delete?: never; options?: never; @@ -4603,9 +5768,12 @@ export interface paths { }; get?: never; put?: never; - /** @description

Cancels a refund with a status of requires_action.

+ /** + * Cancel a refund + * @description

Cancels a refund with a status of requires_action.

* - *

You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.

*/ + *

You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.

+ */ post: operations["PostRefundsRefundCancel"]; delete?: never; options?: never; @@ -4620,10 +5788,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

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

*/ + /** + * List all Report Runs + * @description

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

+ */ get: operations["GetReportingReportRuns"]; put?: never; - /** @description

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

*/ + /** + * Create a Report Run + * @description

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

+ */ post: operations["PostReportingReportRuns"]; delete?: never; options?: never; @@ -4638,7 +5812,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of an existing Report Run.

*/ + /** + * Retrieve a Report Run + * @description

Retrieves the details of an existing Report Run.

+ */ get: operations["GetReportingReportRunsReportRun"]; put?: never; post?: never; @@ -4655,7 +5832,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a full list of Report Types.

*/ + /** + * List all Report Types + * @description

Returns a full list of Report Types.

+ */ get: operations["GetReportingReportTypes"]; put?: never; post?: never; @@ -4672,7 +5852,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

*/ + /** + * Retrieve a Report Type + * @description

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

+ */ get: operations["GetReportingReportTypesReportType"]; put?: never; post?: never; @@ -4689,7 +5872,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

*/ + /** + * List all open reviews + * @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.

+ */ get: operations["GetReviews"]; put?: never; post?: never; @@ -4706,7 +5892,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a Review object.

*/ + /** + * Retrieve a review + * @description

Retrieves a Review object.

+ */ get: operations["GetReviewsReview"]; put?: never; post?: never; @@ -4725,7 +5914,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Approves a Review object, closing it and removing it from the list of reviews.

*/ + /** + * Approve a review + * @description

Approves a Review object, closing it and removing it from the list of reviews.

+ */ post: operations["PostReviewsReviewApprove"]; delete?: never; options?: never; @@ -4740,7 +5932,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

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

*/ + /** + * List all SetupAttempts + * @description

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

+ */ get: operations["GetSetupAttempts"]; put?: never; post?: never; @@ -4757,13 +5952,19 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of SetupIntents.

*/ + /** + * List all SetupIntents + * @description

Returns a list of SetupIntents.

+ */ get: operations["GetSetupIntents"]; put?: never; - /** @description

Creates a SetupIntent object.

+ /** + * Create a SetupIntent + * @description

Creates a SetupIntent object.

* *

After you create the SetupIntent, attach a payment method and confirm - * it to collect any required permissions to charge the payment method later.

*/ + * it to collect any required permissions to charge the payment method later.

+ */ post: operations["PostSetupIntents"]; delete?: never; options?: never; @@ -4778,14 +5979,20 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of a SetupIntent that has previously been created.

+ /** + * Retrieve a SetupIntent + * @description

Retrieves the details of a SetupIntent that has previously been created.

* *

Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

* - *

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.

*/ + *

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.

+ */ get: operations["GetSetupIntentsIntent"]; put?: never; - /** @description

Updates a SetupIntent object.

*/ + /** + * Update a SetupIntent + * @description

Updates a SetupIntent object.

+ */ post: operations["PostSetupIntentsIntent"]; delete?: never; options?: never; @@ -4802,9 +6009,12 @@ export interface paths { }; get?: never; put?: never; - /** @description

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

+ /** + * Cancel a SetupIntent + * @description

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

* - *

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. Expire the Checkout Session instead.

*/ + *

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. Expire the Checkout Session instead.

+ */ post: operations["PostSetupIntentsIntentCancel"]; delete?: never; options?: never; @@ -4821,7 +6031,9 @@ export interface paths { }; get?: never; put?: never; - /** @description

Confirm that your customer intends to set up the current or + /** + * Confirm a SetupIntent + * @description

Confirm that your customer intends to set up the current or * provided payment method. For example, you would confirm a SetupIntent * when a customer hits the “Save” button on a payment method management * page on your website.

@@ -4834,7 +6046,8 @@ export interface paths { * suggest additional actions via next_action. If setup fails, * the SetupIntent will transition to the * requires_payment_method status or the canceled status if the - * confirmation limit is reached.

*/ + * confirmation limit is reached.

+ */ post: operations["PostSetupIntentsIntentConfirm"]; delete?: never; options?: never; @@ -4851,7 +6064,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Verifies microdeposits on a SetupIntent object.

*/ + /** + * Verify microdeposits on a SetupIntent + * @description

Verifies microdeposits on a SetupIntent object.

+ */ post: operations["PostSetupIntentsIntentVerifyMicrodeposits"]; delete?: never; options?: never; @@ -4866,10 +6082,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of your shipping rates.

*/ + /** + * List all shipping rates + * @description

Returns a list of your shipping rates.

+ */ get: operations["GetShippingRates"]; put?: never; - /** @description

Creates a new shipping rate object.

*/ + /** + * Create a shipping rate + * @description

Creates a new shipping rate object.

+ */ post: operations["PostShippingRates"]; delete?: never; options?: never; @@ -4884,10 +6106,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns the shipping rate object with the given ID.

*/ + /** + * Retrieve a shipping rate + * @description

Returns the shipping rate object with the given ID.

+ */ get: operations["GetShippingRatesShippingRateToken"]; put?: never; - /** @description

Updates an existing shipping rate object.

*/ + /** + * Update a shipping rate + * @description

Updates an existing shipping rate object.

+ */ post: operations["PostShippingRatesShippingRateToken"]; delete?: never; options?: never; @@ -4902,7 +6130,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of scheduled query runs.

*/ + /** + * List all scheduled query runs + * @description

Returns a list of scheduled query runs.

+ */ get: operations["GetSigmaScheduledQueryRuns"]; put?: never; post?: never; @@ -4919,7 +6150,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of an scheduled query run.

*/ + /** + * Retrieve a scheduled query run + * @description

Retrieves the details of an scheduled query run.

+ */ get: operations["GetSigmaScheduledQueryRunsScheduledQueryRun"]; put?: never; post?: never; @@ -4938,7 +6172,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Creates a new source object.

*/ + /** + * Shares a source + * @description

Creates a new source object.

+ */ post: operations["PostSources"]; delete?: never; options?: never; @@ -4953,12 +6190,18 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

*/ + /** + * Retrieve a source + * @description

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

+ */ get: operations["GetSourcesSource"]; put?: never; - /** @description

Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ /** + * Update a source + * @description

Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

* - *

This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.

*/ + *

This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.

+ */ post: operations["PostSourcesSource"]; delete?: never; options?: never; @@ -4973,7 +6216,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves a new Source MandateNotification.

*/ + /** + * Retrieve a Source MandateNotification + * @description

Retrieves a new Source MandateNotification.

+ */ get: operations["GetSourcesSourceMandateNotificationsMandateNotification"]; put?: never; post?: never; @@ -5007,7 +6253,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.

*/ + /** + * Retrieve a source transaction + * @description

Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.

+ */ get: operations["GetSourcesSourceSourceTransactionsSourceTransaction"]; put?: never; post?: never; @@ -5041,10 +6290,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of your subscription items for a given subscription.

*/ + /** + * List all subscription items + * @description

Returns a list of your subscription items for a given subscription.

+ */ get: operations["GetSubscriptionItems"]; put?: never; - /** @description

Adds a new item to an existing subscription. No existing items will be changed or replaced.

*/ + /** + * Create a subscription item + * @description

Adds a new item to an existing subscription. No existing items will be changed or replaced.

+ */ post: operations["PostSubscriptionItems"]; delete?: never; options?: never; @@ -5059,12 +6314,21 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the subscription item with the given ID.

*/ + /** + * Retrieve a subscription item + * @description

Retrieves the subscription item with the given ID.

+ */ get: operations["GetSubscriptionItemsItem"]; put?: never; - /** @description

Updates the plan or quantity of an item on a current subscription.

*/ + /** + * Update a subscription item + * @description

Updates the plan or quantity of an item on a current subscription.

+ */ post: operations["PostSubscriptionItemsItem"]; - /** @description

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

*/ + /** + * Delete a subscription item + * @description

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

+ */ delete: operations["DeleteSubscriptionItemsItem"]; options?: never; head?: never; @@ -5078,9 +6342,12 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

+ /** + * List all subscription item period summaries + * @description

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

* - *

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

*/ + *

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

+ */ get: operations["GetSubscriptionItemsSubscriptionItemUsageRecordSummaries"]; put?: never; post?: never; @@ -5099,13 +6366,16 @@ export interface paths { }; get?: never; put?: never; - /** @description

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

+ /** + * Create a usage record + * @description

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

* *

Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the metered billing plan, Stripe helps you send accurate invoices to your customers.

* *

The default calculation for usage is to add up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan’s aggregate_usage parameter. When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter.

* - *

The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

*/ + *

The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

+ */ post: operations["PostSubscriptionItemsSubscriptionItemUsageRecords"]; delete?: never; options?: never; @@ -5120,10 +6390,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the list of your subscription schedules.

*/ + /** + * List all schedules + * @description

Retrieves the list of your subscription schedules.

+ */ get: operations["GetSubscriptionSchedules"]; put?: never; - /** @description

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

*/ + /** + * Create a schedule + * @description

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

+ */ post: operations["PostSubscriptionSchedules"]; delete?: never; options?: never; @@ -5138,10 +6414,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

*/ + /** + * Retrieve a schedule + * @description

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

+ */ get: operations["GetSubscriptionSchedulesSchedule"]; put?: never; - /** @description

Updates an existing subscription schedule.

*/ + /** + * Update a schedule + * @description

Updates an existing subscription schedule.

+ */ post: operations["PostSubscriptionSchedulesSchedule"]; delete?: never; options?: never; @@ -5158,7 +6440,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

*/ + /** + * Cancel a schedule + * @description

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

+ */ post: operations["PostSubscriptionSchedulesScheduleCancel"]; delete?: never; options?: never; @@ -5175,7 +6460,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.

*/ + /** + * Release a schedule + * @description

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.

+ */ post: operations["PostSubscriptionSchedulesScheduleRelease"]; delete?: never; options?: never; @@ -5190,16 +6478,22 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

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

*/ + /** + * List subscriptions + * @description

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

+ */ get: operations["GetSubscriptions"]; put?: never; - /** @description

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

+ /** + * Create a subscription + * @description

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

* *

When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request. * The payment_behavior parameter determines the exact behavior of the initial payment.

* *

To start subscriptions where the first invoice always begins in a draft status, use subscription schedules instead. - * Schedules provide the flexibility to model more complex billing configurations that change over time.

*/ + * Schedules provide the flexibility to model more complex billing configurations that change over time.

+ */ post: operations["PostSubscriptions"]; delete?: never; options?: never; @@ -5214,10 +6508,13 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Search for subscriptions you’ve previously created using Stripe’s Search Query Language. + /** + * Search subscriptions + * @description

Search for subscriptions you’ve previously created using Stripe’s Search Query Language. * Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up - * to an hour behind during outages. Search functionality is not available to merchants in India.

*/ + * to an hour behind during outages. Search functionality is not available to merchants in India.

+ */ get: operations["GetSubscriptionsSearch"]; put?: never; post?: never; @@ -5234,10 +6531,15 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the subscription with the given ID.

*/ + /** + * Retrieve a subscription + * @description

Retrieves the subscription with the given ID.

+ */ get: operations["GetSubscriptionsSubscriptionExposedId"]; put?: never; - /** @description

Updates an existing subscription to match the specified parameters. + /** + * Update a subscription + * @description

Updates an existing subscription to match the specified parameters. * When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. * To preview how the proration is calculated, use the create preview endpoint.

* @@ -5251,19 +6553,23 @@ export interface paths { *
  • A trial starts or ends.
    • * * - *

    In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how Stripe immediately attempts payment for subscription changes.

    + *

    In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how Stripe immediately attempts payment for subscription changes.

    * *

    If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.

    * *

    If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.

    * - *

    Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

    */ + *

    Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

    + */ post: operations["PostSubscriptionsSubscriptionExposedId"]; - /** @description

    Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

    + /** + * Cancel a subscription + * @description

    Cancels a customer’s subscription immediately. The customer won’t be charged again for the subscription. After it’s canceled, you can no longer update the subscription or its metadata.

    * - *

    Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

    + *

    Any pending invoice items that you’ve created are still charged at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed.

    * - *

    By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

    */ + *

    By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

    + */ delete: operations["DeleteSubscriptionsSubscriptionExposedId"]; options?: never; head?: never; @@ -5280,7 +6586,10 @@ export interface paths { get?: never; put?: never; post?: never; - /** @description

    Removes the currently applied discount on a subscription.

    */ + /** + * Delete a subscription discount + * @description

    Removes the currently applied discount on a subscription.

    + */ delete: operations["DeleteSubscriptionsSubscriptionExposedIdDiscount"]; options?: never; head?: never; @@ -5296,7 +6605,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.

    */ + /** + * Resume a subscription + * @description

    Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.

    + */ post: operations["PostSubscriptionsSubscriptionResume"]; delete?: never; options?: never; @@ -5313,7 +6625,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Calculates tax based on the input and returns a Tax Calculation object.

    */ + /** + * Create a Tax Calculation + * @description

    Calculates tax based on the input and returns a Tax Calculation object.

    + */ post: operations["PostTaxCalculations"]; delete?: never; options?: never; @@ -5328,7 +6643,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves a Tax Calculation object, if the calculation hasn’t expired.

    */ + /** + * Retrieve a Tax Calculation + * @description

    Retrieves a Tax Calculation object, if the calculation hasn’t expired.

    + */ get: operations["GetTaxCalculationsCalculation"]; put?: never; post?: never; @@ -5345,7 +6663,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.

    */ + /** + * Retrieve a calculation's line items + * @description

    Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.

    + */ get: operations["GetTaxCalculationsCalculationLineItems"]; put?: never; post?: never; @@ -5362,10 +6683,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of Tax Registration objects.

    */ + /** + * List registrations + * @description

    Returns a list of Tax Registration objects.

    + */ get: operations["GetTaxRegistrations"]; put?: never; - /** @description

    Creates a new Tax Registration object.

    */ + /** + * Create a registration + * @description

    Creates a new Tax Registration object.

    + */ post: operations["PostTaxRegistrations"]; delete?: never; options?: never; @@ -5380,12 +6707,18 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a Tax Registration object.

    */ + /** + * Retrieve a registration + * @description

    Returns a Tax Registration object.

    + */ get: operations["GetTaxRegistrationsId"]; put?: never; - /** @description

    Updates an existing Tax Registration object.

    + /** + * Update a registration + * @description

    Updates an existing Tax Registration object.

    * - *

    A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

    */ + *

    A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

    + */ post: operations["PostTaxRegistrationsId"]; delete?: never; options?: never; @@ -5400,10 +6733,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves Tax Settings for a merchant.

    */ + /** + * Retrieve settings + * @description

    Retrieves Tax Settings for a merchant.

    + */ get: operations["GetTaxSettings"]; put?: never; - /** @description

    Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.

    */ + /** + * Update settings + * @description

    Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.

    + */ post: operations["PostTaxSettings"]; delete?: never; options?: never; @@ -5420,7 +6759,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.

    */ + /** + * Create a transaction from a calculation + * @description

    Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.

    + */ post: operations["PostTaxTransactionsCreateFromCalculation"]; delete?: never; options?: never; @@ -5437,7 +6779,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Partially or fully reverses a previously created Transaction.

    */ + /** + * Create a reversal transaction + * @description

    Partially or fully reverses a previously created Transaction.

    + */ post: operations["PostTaxTransactionsCreateReversal"]; delete?: never; options?: never; @@ -5452,7 +6797,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves a Tax Transaction object.

    */ + /** + * Retrieve a transaction + * @description

    Retrieves a Tax Transaction object.

    + */ get: operations["GetTaxTransactionsTransaction"]; put?: never; post?: never; @@ -5469,7 +6817,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves the line items of a committed standalone transaction as a collection.

    */ + /** + * Retrieve a transaction's line items + * @description

    Retrieves the line items of a committed standalone transaction as a collection.

    + */ get: operations["GetTaxTransactionsTransactionLineItems"]; put?: never; post?: never; @@ -5486,7 +6837,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

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

    */ + /** + * List all tax codes + * @description

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

    + */ get: operations["GetTaxCodes"]; put?: never; post?: never; @@ -5503,7 +6857,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

    */ + /** + * Retrieve a tax code + * @description

    Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

    + */ get: operations["GetTaxCodesId"]; put?: never; post?: never; @@ -5520,10 +6877,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of tax IDs.

    */ + /** + * List all tax IDs + * @description

    Returns a list of tax IDs.

    + */ get: operations["GetTaxIds"]; put?: never; - /** @description

    Creates a new account or customer tax_id object.

    */ + /** + * Create a tax ID + * @description

    Creates a new account or customer tax_id object.

    + */ post: operations["PostTaxIds"]; delete?: never; options?: never; @@ -5538,11 +6901,17 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves an account or customer tax_id object.

    */ + /** + * Retrieve a tax ID + * @description

    Retrieves an account or customer tax_id object.

    + */ get: operations["GetTaxIdsId"]; put?: never; post?: never; - /** @description

    Deletes an existing account or customer tax_id object.

    */ + /** + * Delete a tax ID + * @description

    Deletes an existing account or customer tax_id object.

    + */ delete: operations["DeleteTaxIdsId"]; options?: never; head?: never; @@ -5556,10 +6925,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

    */ + /** + * List all tax rates + * @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.

    + */ get: operations["GetTaxRates"]; put?: never; - /** @description

    Creates a new tax rate.

    */ + /** + * Create a tax rate + * @description

    Creates a new tax rate.

    + */ post: operations["PostTaxRates"]; delete?: never; options?: never; @@ -5574,10 +6949,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves a tax rate with the given ID

    */ + /** + * Retrieve a tax rate + * @description

    Retrieves a tax rate with the given ID

    + */ get: operations["GetTaxRatesTaxRate"]; put?: never; - /** @description

    Updates an existing tax rate.

    */ + /** + * Update a tax rate + * @description

    Updates an existing tax rate.

    + */ post: operations["PostTaxRatesTaxRate"]; delete?: never; options?: never; @@ -5592,10 +6973,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of Configuration objects.

    */ + /** + * List all Configurations + * @description

    Returns a list of Configuration objects.

    + */ get: operations["GetTerminalConfigurations"]; put?: never; - /** @description

    Creates a new Configuration object.

    */ + /** + * Create a Configuration + * @description

    Creates a new Configuration object.

    + */ post: operations["PostTerminalConfigurations"]; delete?: never; options?: never; @@ -5610,12 +6997,21 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves a Configuration object.

    */ + /** + * Retrieve a Configuration + * @description

    Retrieves a Configuration object.

    + */ get: operations["GetTerminalConfigurationsConfiguration"]; put?: never; - /** @description

    Updates a new Configuration object.

    */ + /** + * Update a Configuration + * @description

    Updates a new Configuration object.

    + */ post: operations["PostTerminalConfigurationsConfiguration"]; - /** @description

    Deletes a Configuration object.

    */ + /** + * Delete a Configuration + * @description

    Deletes a Configuration object.

    + */ delete: operations["DeleteTerminalConfigurationsConfiguration"]; options?: never; head?: never; @@ -5631,7 +7027,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

    */ + /** + * Create a Connection Token + * @description

    To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

    + */ post: operations["PostTerminalConnectionTokens"]; delete?: never; options?: never; @@ -5646,11 +7045,17 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of Location objects.

    */ + /** + * List all Locations + * @description

    Returns a list of Location objects.

    + */ get: operations["GetTerminalLocations"]; put?: never; - /** @description

    Creates a new Location object. - * For further details, including which address fields are required in each country, see the Manage locations guide.

    */ + /** + * Create a Location + * @description

    Creates a new Location object. + * For further details, including which address fields are required in each country, see the Manage locations guide.

    + */ post: operations["PostTerminalLocations"]; delete?: never; options?: never; @@ -5665,12 +7070,21 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves a Location object.

    */ + /** + * Retrieve a Location + * @description

    Retrieves a Location object.

    + */ get: operations["GetTerminalLocationsLocation"]; put?: never; - /** @description

    Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

    */ + /** + * Update a Location + * @description

    Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

    + */ post: operations["PostTerminalLocationsLocation"]; - /** @description

    Deletes a Location object.

    */ + /** + * Delete a Location + * @description

    Deletes a Location object.

    + */ delete: operations["DeleteTerminalLocationsLocation"]; options?: never; head?: never; @@ -5684,10 +7098,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of Reader objects.

    */ + /** + * List all Readers + * @description

    Returns a list of Reader objects.

    + */ get: operations["GetTerminalReaders"]; put?: never; - /** @description

    Creates a new Reader object.

    */ + /** + * Create a Reader + * @description

    Creates a new Reader object.

    + */ post: operations["PostTerminalReaders"]; delete?: never; options?: never; @@ -5702,12 +7122,21 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves a Reader object.

    */ + /** + * Retrieve a Reader + * @description

    Retrieves a Reader object.

    + */ get: operations["GetTerminalReadersReader"]; put?: never; - /** @description

    Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

    */ + /** + * Update a Reader + * @description

    Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

    + */ post: operations["PostTerminalReadersReader"]; - /** @description

    Deletes a Reader object.

    */ + /** + * Delete a Reader + * @description

    Deletes a Reader object.

    + */ delete: operations["DeleteTerminalReadersReader"]; options?: never; head?: never; @@ -5723,7 +7152,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Cancels the current reader action.

    */ + /** + * Cancel the current reader action + * @description

    Cancels the current reader action.

    + */ post: operations["PostTerminalReadersReaderCancelAction"]; delete?: never; options?: never; @@ -5740,7 +7172,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Initiates a payment flow on a Reader.

    */ + /** + * Hand-off a PaymentIntent to a Reader + * @description

    Initiates a payment flow on a Reader.

    + */ post: operations["PostTerminalReadersReaderProcessPaymentIntent"]; delete?: never; options?: never; @@ -5757,7 +7192,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Initiates a setup intent flow on a Reader.

    */ + /** + * Hand-off a SetupIntent to a Reader + * @description

    Initiates a setup intent flow on a Reader.

    + */ post: operations["PostTerminalReadersReaderProcessSetupIntent"]; delete?: never; options?: never; @@ -5774,7 +7212,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Initiates a refund on a Reader

    */ + /** + * Refund a Charge or a PaymentIntent in-person + * @description

    Initiates a refund on a Reader

    + */ post: operations["PostTerminalReadersReaderRefundPayment"]; delete?: never; options?: never; @@ -5791,7 +7232,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Sets reader display to show cart details.

    */ + /** + * Set reader display + * @description

    Sets reader display to show cart details.

    + */ post: operations["PostTerminalReadersReaderSetReaderDisplay"]; delete?: never; options?: never; @@ -5808,7 +7252,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Creates a test mode Confirmation Token server side for your integration tests.

    */ + /** + * Create a test Confirmation Token + * @description

    Creates a test mode Confirmation Token server side for your integration tests.

    + */ post: operations["PostTestHelpersConfirmationTokens"]; delete?: never; options?: never; @@ -5825,7 +7272,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Create an incoming testmode bank transfer

    */ + /** + * Fund a test mode cash balance + * @description

    Create an incoming testmode bank transfer

    + */ post: operations["PostTestHelpersCustomersCustomerFundCashBalance"]; delete?: never; options?: never; @@ -5842,7 +7292,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Create a test-mode authorization.

    */ + /** + * Create a test-mode authorization + * @description

    Create a test-mode authorization.

    + */ post: operations["PostTestHelpersIssuingAuthorizations"]; delete?: never; options?: never; @@ -5859,7 +7312,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Capture a test-mode authorization.

    */ + /** + * Capture a test-mode authorization + * @description

    Capture a test-mode authorization.

    + */ post: operations["PostTestHelpersIssuingAuthorizationsAuthorizationCapture"]; delete?: never; options?: never; @@ -5876,7 +7332,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Expire a test-mode Authorization.

    */ + /** + * Expire a test-mode authorization + * @description

    Expire a test-mode Authorization.

    + */ post: operations["PostTestHelpersIssuingAuthorizationsAuthorizationExpire"]; delete?: never; options?: never; @@ -5893,7 +7352,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.

    */ + /** + * Finalize a test-mode authorization's amount + * @description

    Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.

    + */ post: operations["PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount"]; delete?: never; options?: never; @@ -5901,6 +7363,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/test_helpers/issuing/authorizations/{authorization}/fraud_challenges/respond": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Respond to fraud challenge + * @description

    Respond to a fraud challenge on a testmode Issuing authorization, simulating either a confirmation of fraud or a correction of legitimacy.

    + */ + post: operations["PostTestHelpersIssuingAuthorizationsAuthorizationFraudChallengesRespond"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/test_helpers/issuing/authorizations/{authorization}/increment": { parameters: { query?: never; @@ -5910,7 +7392,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Increment a test-mode Authorization.

    */ + /** + * Increment a test-mode authorization + * @description

    Increment a test-mode Authorization.

    + */ post: operations["PostTestHelpersIssuingAuthorizationsAuthorizationIncrement"]; delete?: never; options?: never; @@ -5927,7 +7412,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Reverse a test-mode Authorization.

    */ + /** + * Reverse a test-mode authorization + * @description

    Reverse a test-mode Authorization.

    + */ post: operations["PostTestHelpersIssuingAuthorizationsAuthorizationReverse"]; delete?: never; options?: never; @@ -5944,7 +7432,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Updates the shipping status of the specified Issuing Card object to delivered.

    */ + /** + * Deliver a testmode card + * @description

    Updates the shipping status of the specified Issuing Card object to delivered.

    + */ post: operations["PostTestHelpersIssuingCardsCardShippingDeliver"]; delete?: never; options?: never; @@ -5961,7 +7452,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Updates the shipping status of the specified Issuing Card object to failure.

    */ + /** + * Fail a testmode card + * @description

    Updates the shipping status of the specified Issuing Card object to failure.

    + */ post: operations["PostTestHelpersIssuingCardsCardShippingFail"]; delete?: never; options?: never; @@ -5978,7 +7472,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Updates the shipping status of the specified Issuing Card object to returned.

    */ + /** + * Return a testmode card + * @description

    Updates the shipping status of the specified Issuing Card object to returned.

    + */ post: operations["PostTestHelpersIssuingCardsCardShippingReturn"]; delete?: never; options?: never; @@ -5995,7 +7492,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Updates the shipping status of the specified Issuing Card object to shipped.

    */ + /** + * Ship a testmode card + * @description

    Updates the shipping status of the specified Issuing Card object to shipped.

    + */ post: operations["PostTestHelpersIssuingCardsCardShippingShip"]; delete?: never; options?: never; @@ -6003,6 +7503,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/test_helpers/issuing/cards/{card}/shipping/submit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Submit a testmode card + * @description

    Updates the shipping status of the specified Issuing Card object to submitted. This method requires Stripe Version ‘2024-09-30.acacia’ or later.

    + */ + post: operations["PostTestHelpersIssuingCardsCardShippingSubmit"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate": { parameters: { query?: never; @@ -6012,7 +7532,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Updates the status of the specified testmode personalization design object to active.

    */ + /** + * Activate a testmode personalization design + * @description

    Updates the status of the specified testmode personalization design object to active.

    + */ post: operations["PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate"]; delete?: never; options?: never; @@ -6029,7 +7552,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Updates the status of the specified testmode personalization design object to inactive.

    */ + /** + * Deactivate a testmode personalization design + * @description

    Updates the status of the specified testmode personalization design object to inactive.

    + */ post: operations["PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate"]; delete?: never; options?: never; @@ -6046,7 +7572,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Updates the status of the specified testmode personalization design object to rejected.

    */ + /** + * Reject a testmode personalization design + * @description

    Updates the status of the specified testmode personalization design object to rejected.

    + */ post: operations["PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject"]; delete?: never; options?: never; @@ -6063,7 +7592,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Allows the user to create an Issuing settlement.

    */ + /** + * Create a test-mode settleemnt + * @description

    Allows the user to create an Issuing settlement.

    + */ post: operations["PostTestHelpersIssuingSettlements"]; delete?: never; options?: never; @@ -6080,7 +7612,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Allows the user to capture an arbitrary amount, also known as a forced capture.

    */ + /** + * Create a test-mode force capture + * @description

    Allows the user to capture an arbitrary amount, also known as a forced capture.

    + */ post: operations["PostTestHelpersIssuingTransactionsCreateForceCapture"]; delete?: never; options?: never; @@ -6097,7 +7632,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Allows the user to refund an arbitrary amount, also known as a unlinked refund.

    */ + /** + * Create a test-mode unlinked refund + * @description

    Allows the user to refund an arbitrary amount, also known as a unlinked refund.

    + */ post: operations["PostTestHelpersIssuingTransactionsCreateUnlinkedRefund"]; delete?: never; options?: never; @@ -6114,7 +7652,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Refund a test-mode Transaction.

    */ + /** + * Refund a test-mode transaction + * @description

    Refund a test-mode Transaction.

    + */ post: operations["PostTestHelpersIssuingTransactionsTransactionRefund"]; delete?: never; options?: never; @@ -6131,7 +7672,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Expire a refund with a status of requires_action.

    */ + /** + * Expire a pending refund. + * @description

    Expire a refund with a status of requires_action.

    + */ post: operations["PostTestHelpersRefundsRefundExpire"]; delete?: never; options?: never; @@ -6148,7 +7692,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.

    */ + /** + * Simulate presenting a payment method + * @description

    Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.

    + */ post: operations["PostTestHelpersTerminalReadersReaderPresentPaymentMethod"]; delete?: never; options?: never; @@ -6163,10 +7710,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of your test clocks.

    */ + /** + * List all test clocks + * @description

    Returns a list of your test clocks.

    + */ get: operations["GetTestHelpersTestClocks"]; put?: never; - /** @description

    Creates a new test clock that can be attached to new customers and quotes.

    */ + /** + * Create a test clock + * @description

    Creates a new test clock that can be attached to new customers and quotes.

    + */ post: operations["PostTestHelpersTestClocks"]; delete?: never; options?: never; @@ -6181,11 +7734,17 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves a test clock.

    */ + /** + * Retrieve a test clock + * @description

    Retrieves a test clock.

    + */ get: operations["GetTestHelpersTestClocksTestClock"]; put?: never; post?: never; - /** @description

    Deletes a test clock.

    */ + /** + * Delete a test clock + * @description

    Deletes a test clock.

    + */ delete: operations["DeleteTestHelpersTestClocksTestClock"]; options?: never; head?: never; @@ -6201,7 +7760,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

    */ + /** + * Advance a test clock + * @description

    Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

    + */ post: operations["PostTestHelpersTestClocksTestClockAdvance"]; delete?: never; options?: never; @@ -6218,7 +7780,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

    */ + /** + * Test mode: Fail an InboundTransfer + * @description

    Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

    + */ post: operations["PostTestHelpersTreasuryInboundTransfersIdFail"]; delete?: never; options?: never; @@ -6235,7 +7800,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.

    */ + /** + * Test mode: Return an InboundTransfer + * @description

    Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.

    + */ post: operations["PostTestHelpersTreasuryInboundTransfersIdReturn"]; delete?: never; options?: never; @@ -6252,7 +7820,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.

    */ + /** + * Test mode: Succeed an InboundTransfer + * @description

    Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.

    + */ post: operations["PostTestHelpersTreasuryInboundTransfersIdSucceed"]; delete?: never; options?: never; @@ -6269,7 +7840,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.

    */ + /** + * Test mode: Update an OutboundPayment + * @description

    Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.

    + */ post: operations["PostTestHelpersTreasuryOutboundPaymentsId"]; delete?: never; options?: never; @@ -6286,7 +7860,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

    */ + /** + * Test mode: Fail an OutboundPayment + * @description

    Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

    + */ post: operations["PostTestHelpersTreasuryOutboundPaymentsIdFail"]; delete?: never; options?: never; @@ -6303,7 +7880,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

    */ + /** + * Test mode: Post an OutboundPayment + * @description

    Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

    + */ post: operations["PostTestHelpersTreasuryOutboundPaymentsIdPost"]; delete?: never; options?: never; @@ -6320,7 +7900,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

    */ + /** + * Test mode: Return an OutboundPayment + * @description

    Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

    + */ post: operations["PostTestHelpersTreasuryOutboundPaymentsIdReturn"]; delete?: never; options?: never; @@ -6337,7 +7920,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.

    */ + /** + * Test mode: Update an OutboundTransfer + * @description

    Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.

    + */ post: operations["PostTestHelpersTreasuryOutboundTransfersOutboundTransfer"]; delete?: never; options?: never; @@ -6354,7 +7940,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.

    */ + /** + * Test mode: Fail an OutboundTransfer + * @description

    Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.

    + */ post: operations["PostTestHelpersTreasuryOutboundTransfersOutboundTransferFail"]; delete?: never; options?: never; @@ -6371,7 +7960,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.

    */ + /** + * Test mode: Post an OutboundTransfer + * @description

    Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.

    + */ post: operations["PostTestHelpersTreasuryOutboundTransfersOutboundTransferPost"]; delete?: never; options?: never; @@ -6388,7 +7980,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.

    */ + /** + * Test mode: Return an OutboundTransfer + * @description

    Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.

    + */ post: operations["PostTestHelpersTreasuryOutboundTransfersOutboundTransferReturn"]; delete?: never; options?: never; @@ -6405,7 +8000,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.

    */ + /** + * Test mode: Create a ReceivedCredit + * @description

    Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.

    + */ post: operations["PostTestHelpersTreasuryReceivedCredits"]; delete?: never; options?: never; @@ -6422,7 +8020,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.

    */ + /** + * Test mode: Create a ReceivedDebit + * @description

    Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.

    + */ post: operations["PostTestHelpersTreasuryReceivedDebits"]; delete?: never; options?: never; @@ -6439,8 +8040,11 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Creates a single-use token that represents a bank account’s details. - * You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a connected account where controller.requirement_collection is application, which includes Custom accounts.

    */ + /** + * Create a CVC update token + * @description

    Creates a single-use token that represents a bank account’s details. + * You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a connected account where controller.requirement_collection is application, which includes Custom accounts.

    + */ post: operations["PostTokens"]; delete?: never; options?: never; @@ -6455,7 +8059,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves the token with the given ID.

    */ + /** + * Retrieve a token + * @description

    Retrieves the token with the given ID.

    + */ get: operations["GetTokensToken"]; put?: never; post?: never; @@ -6472,10 +8079,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of top-ups.

    */ + /** + * List all top-ups + * @description

    Returns a list of top-ups.

    + */ get: operations["GetTopups"]; put?: never; - /** @description

    Top up the balance of an account

    */ + /** + * Create a top-up + * @description

    Top up the balance of an account

    + */ post: operations["PostTopups"]; delete?: never; options?: never; @@ -6490,10 +8103,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

    */ + /** + * Retrieve a top-up + * @description

    Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

    + */ get: operations["GetTopupsTopup"]; put?: never; - /** @description

    Updates the metadata of a top-up. Other top-up details are not editable by design.

    */ + /** + * Update a top-up + * @description

    Updates the metadata of a top-up. Other top-up details are not editable by design.

    + */ post: operations["PostTopupsTopup"]; delete?: never; options?: never; @@ -6510,7 +8129,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Cancels a top-up. Only pending top-ups can be canceled.

    */ + /** + * Cancel a top-up + * @description

    Cancels a top-up. Only pending top-ups can be canceled.

    + */ post: operations["PostTopupsTopupCancel"]; delete?: never; options?: never; @@ -6525,10 +8147,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @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.

    */ + /** + * List all transfers + * @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.

    + */ get: operations["GetTransfers"]; put?: never; - /** @description

    To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

    */ + /** + * Create a transfer + * @description

    To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

    + */ post: operations["PostTransfers"]; delete?: never; options?: never; @@ -6543,14 +8171,20 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

    */ + /** + * List all reversals + * @description

    You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

    + */ get: operations["GetTransfersIdReversals"]; put?: never; - /** @description

    When you create a new reversal, you must specify a transfer to create it on.

    + /** + * Create a transfer reversal + * @description

    When you create a new reversal, you must specify a transfer to create it on.

    * *

    When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

    * - *

    Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

    */ + *

    Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

    + */ post: operations["PostTransfersIdReversals"]; delete?: never; options?: never; @@ -6565,12 +8199,18 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

    */ + /** + * Retrieve a transfer + * @description

    Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

    + */ get: operations["GetTransfersTransfer"]; put?: never; - /** @description

    Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

    + /** + * Update a transfer + * @description

    Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

    * - *

    This request accepts only metadata as an argument.

    */ + *

    This request accepts only metadata as an argument.

    + */ post: operations["PostTransfersTransfer"]; delete?: never; options?: never; @@ -6585,12 +8225,18 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

    */ + /** + * Retrieve a reversal + * @description

    By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

    + */ get: operations["GetTransfersTransferReversalsId"]; put?: never; - /** @description

    Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

    + /** + * Update a reversal + * @description

    Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

    * - *

    This request only accepts metadata and description as arguments.

    */ + *

    This request only accepts metadata and description as arguments.

    + */ post: operations["PostTransfersTransferReversalsId"]; delete?: never; options?: never; @@ -6605,10 +8251,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of CreditReversals.

    */ + /** + * List all CreditReversals + * @description

    Returns a list of CreditReversals.

    + */ get: operations["GetTreasuryCreditReversals"]; put?: never; - /** @description

    Reverses a ReceivedCredit and creates a CreditReversal object.

    */ + /** + * Create a CreditReversal + * @description

    Reverses a ReceivedCredit and creates a CreditReversal object.

    + */ post: operations["PostTreasuryCreditReversals"]; delete?: never; options?: never; @@ -6623,7 +8275,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list

    */ + /** + * Retrieve a CreditReversal + * @description

    Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list

    + */ get: operations["GetTreasuryCreditReversalsCreditReversal"]; put?: never; post?: never; @@ -6640,10 +8295,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of DebitReversals.

    */ + /** + * List all DebitReversals + * @description

    Returns a list of DebitReversals.

    + */ get: operations["GetTreasuryDebitReversals"]; put?: never; - /** @description

    Reverses a ReceivedDebit and creates a DebitReversal object.

    */ + /** + * Create a DebitReversal + * @description

    Reverses a ReceivedDebit and creates a DebitReversal object.

    + */ post: operations["PostTreasuryDebitReversals"]; delete?: never; options?: never; @@ -6658,7 +8319,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves a DebitReversal object.

    */ + /** + * Retrieve a DebitReversal + * @description

    Retrieves a DebitReversal object.

    + */ get: operations["GetTreasuryDebitReversalsDebitReversal"]; put?: never; post?: never; @@ -6675,10 +8339,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of FinancialAccounts.

    */ + /** + * List all FinancialAccounts + * @description

    Returns a list of FinancialAccounts.

    + */ get: operations["GetTreasuryFinancialAccounts"]; put?: never; - /** @description

    Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.

    */ + /** + * Create a FinancialAccount + * @description

    Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.

    + */ post: operations["PostTreasuryFinancialAccounts"]; delete?: never; options?: never; @@ -6693,10 +8363,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves the details of a FinancialAccount.

    */ + /** + * Retrieve a FinancialAccount + * @description

    Retrieves the details of a FinancialAccount.

    + */ get: operations["GetTreasuryFinancialAccountsFinancialAccount"]; put?: never; - /** @description

    Updates the details of a FinancialAccount.

    */ + /** + * Update a FinancialAccount + * @description

    Updates the details of a FinancialAccount.

    + */ post: operations["PostTreasuryFinancialAccountsFinancialAccount"]; delete?: never; options?: never; @@ -6711,10 +8387,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves Features information associated with the FinancialAccount.

    */ + /** + * Retrieve FinancialAccount Features + * @description

    Retrieves Features information associated with the FinancialAccount.

    + */ get: operations["GetTreasuryFinancialAccountsFinancialAccountFeatures"]; put?: never; - /** @description

    Updates the Features associated with a FinancialAccount.

    */ + /** + * Update FinancialAccount Features + * @description

    Updates the Features associated with a FinancialAccount.

    + */ post: operations["PostTreasuryFinancialAccountsFinancialAccountFeatures"]; delete?: never; options?: never; @@ -6729,10 +8411,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of InboundTransfers sent from the specified FinancialAccount.

    */ + /** + * List all InboundTransfers + * @description

    Returns a list of InboundTransfers sent from the specified FinancialAccount.

    + */ get: operations["GetTreasuryInboundTransfers"]; put?: never; - /** @description

    Creates an InboundTransfer.

    */ + /** + * Create an InboundTransfer + * @description

    Creates an InboundTransfer.

    + */ post: operations["PostTreasuryInboundTransfers"]; delete?: never; options?: never; @@ -6747,7 +8435,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves the details of an existing InboundTransfer.

    */ + /** + * Retrieve an InboundTransfer + * @description

    Retrieves the details of an existing InboundTransfer.

    + */ get: operations["GetTreasuryInboundTransfersId"]; put?: never; post?: never; @@ -6766,7 +8457,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Cancels an InboundTransfer.

    */ + /** + * Cancel an InboundTransfer + * @description

    Cancels an InboundTransfer.

    + */ post: operations["PostTreasuryInboundTransfersInboundTransferCancel"]; delete?: never; options?: never; @@ -6781,10 +8475,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of OutboundPayments sent from the specified FinancialAccount.

    */ + /** + * List all OutboundPayments + * @description

    Returns a list of OutboundPayments sent from the specified FinancialAccount.

    + */ get: operations["GetTreasuryOutboundPayments"]; put?: never; - /** @description

    Creates an OutboundPayment.

    */ + /** + * Create an OutboundPayment + * @description

    Creates an OutboundPayment.

    + */ post: operations["PostTreasuryOutboundPayments"]; delete?: never; options?: never; @@ -6799,7 +8499,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.

    */ + /** + * Retrieve an OutboundPayment + * @description

    Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.

    + */ get: operations["GetTreasuryOutboundPaymentsId"]; put?: never; post?: never; @@ -6818,7 +8521,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    Cancel an OutboundPayment.

    */ + /** + * Cancel an OutboundPayment + * @description

    Cancel an OutboundPayment.

    + */ post: operations["PostTreasuryOutboundPaymentsIdCancel"]; delete?: never; options?: never; @@ -6833,10 +8539,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of OutboundTransfers sent from the specified FinancialAccount.

    */ + /** + * List all OutboundTransfers + * @description

    Returns a list of OutboundTransfers sent from the specified FinancialAccount.

    + */ get: operations["GetTreasuryOutboundTransfers"]; put?: never; - /** @description

    Creates an OutboundTransfer.

    */ + /** + * Create an OutboundTransfer + * @description

    Creates an OutboundTransfer.

    + */ post: operations["PostTreasuryOutboundTransfers"]; delete?: never; options?: never; @@ -6851,7 +8563,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.

    */ + /** + * Retrieve an OutboundTransfer + * @description

    Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.

    + */ get: operations["GetTreasuryOutboundTransfersOutboundTransfer"]; put?: never; post?: never; @@ -6870,7 +8585,10 @@ export interface paths { }; get?: never; put?: never; - /** @description

    An OutboundTransfer can be canceled if the funds have not yet been paid out.

    */ + /** + * Cancel an OutboundTransfer + * @description

    An OutboundTransfer can be canceled if the funds have not yet been paid out.

    + */ post: operations["PostTreasuryOutboundTransfersOutboundTransferCancel"]; delete?: never; options?: never; @@ -6885,7 +8603,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of ReceivedCredits.

    */ + /** + * List all ReceivedCredits + * @description

    Returns a list of ReceivedCredits.

    + */ get: operations["GetTreasuryReceivedCredits"]; put?: never; post?: never; @@ -6902,7 +8623,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.

    */ + /** + * Retrieve a ReceivedCredit + * @description

    Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.

    + */ get: operations["GetTreasuryReceivedCreditsId"]; put?: never; post?: never; @@ -6919,7 +8643,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of ReceivedDebits.

    */ + /** + * List all ReceivedDebits + * @description

    Returns a list of ReceivedDebits.

    + */ get: operations["GetTreasuryReceivedDebits"]; put?: never; post?: never; @@ -6936,7 +8663,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list

    */ + /** + * Retrieve a ReceivedDebit + * @description

    Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list

    + */ get: operations["GetTreasuryReceivedDebitsId"]; put?: never; post?: never; @@ -6953,7 +8683,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves a list of TransactionEntry objects.

    */ + /** + * List all TransactionEntries + * @description

    Retrieves a list of TransactionEntry objects.

    + */ get: operations["GetTreasuryTransactionEntries"]; put?: never; post?: never; @@ -6970,7 +8703,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves a TransactionEntry object.

    */ + /** + * Retrieve a TransactionEntry + * @description

    Retrieves a TransactionEntry object.

    + */ get: operations["GetTreasuryTransactionEntriesId"]; put?: never; post?: never; @@ -6987,7 +8723,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves a list of Transaction objects.

    */ + /** + * List all Transactions + * @description

    Retrieves a list of Transaction objects.

    + */ get: operations["GetTreasuryTransactions"]; put?: never; post?: never; @@ -7004,7 +8743,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves the details of an existing Transaction.

    */ + /** + * Retrieve a Transaction + * @description

    Retrieves the details of an existing Transaction.

    + */ get: operations["GetTreasuryTransactionsId"]; put?: never; post?: never; @@ -7021,10 +8763,16 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Returns a list of your webhook endpoints.

    */ + /** + * List all webhook endpoints + * @description

    Returns a list of your webhook endpoints.

    + */ get: operations["GetWebhookEndpoints"]; put?: never; - /** @description

    A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

    */ + /** + * Create a webhook endpoint + * @description

    A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

    + */ post: operations["PostWebhookEndpoints"]; delete?: never; options?: never; @@ -7039,12 +8787,21 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

    Retrieves the webhook endpoint with the given ID.

    */ + /** + * Retrieve a webhook endpoint + * @description

    Retrieves the webhook endpoint with the given ID.

    + */ get: operations["GetWebhookEndpointsWebhookEndpoint"]; put?: never; - /** @description

    Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

    */ + /** + * Update a webhook endpoint + * @description

    Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

    + */ post: operations["PostWebhookEndpointsWebhookEndpoint"]; - /** @description

    You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

    */ + /** + * Delete a webhook endpoint + * @description

    You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

    + */ delete: operations["DeleteWebhookEndpointsWebhookEndpoint"]; options?: never; head?: never; @@ -7079,7 +8836,7 @@ export interface components { */ business_type?: "company" | "government_entity" | "individual" | "non_profit" | null; capabilities?: components["schemas"]["account_capabilities"]; - /** @description Whether the account can create live charges. */ + /** @description Whether the account can process charges. */ charges_enabled?: boolean; company?: components["schemas"]["legal_entity_company"]; controller?: components["schemas"]["account_unification_account_controller"]; @@ -7114,6 +8871,8 @@ export interface components { url: string; }; future_requirements?: components["schemas"]["account_future_requirements"]; + /** @description The groups associated with the account. */ + groups?: components["schemas"]["account_group_membership"] | null; /** @description Unique identifier for the object. */ id: string; individual?: components["schemas"]["person"]; @@ -7126,7 +8885,7 @@ export interface components { * @enum {string} */ object: "account"; - /** @description Whether Stripe can send payouts to this account. */ + /** @description Whether the funds in this account can be paid out. */ payouts_enabled?: boolean; requirements?: components["schemas"]["account_requirements"]; /** @description Options for customizing how the account functions within Stripe. */ @@ -7206,6 +8965,11 @@ export interface components { * @enum {string} */ afterpay_clearpay_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the Alma capability of the account, or whether the account can directly process Alma payments. + * @enum {string} + */ + alma_payments?: "active" | "inactive" | "pending"; /** * @description The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments. * @enum {string} @@ -7306,6 +9070,11 @@ export interface components { * @enum {string} */ jp_bank_transfer_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments. + * @enum {string} + */ + kakao_pay_payments?: "active" | "inactive" | "pending"; /** * @description The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges. * @enum {string} @@ -7316,6 +9085,11 @@ export interface components { * @enum {string} */ konbini_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the KrCard capability of the account, or whether the account can directly process KrCard payments. + * @enum {string} + */ + kr_card_payments?: "active" | "inactive" | "pending"; /** * @description The status of the legacy payments capability of the account. * @enum {string} @@ -7341,6 +9115,11 @@ export interface components { * @enum {string} */ mx_bank_transfer_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments. + * @enum {string} + */ + naver_pay_payments?: "active" | "inactive" | "pending"; /** * @description The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. * @enum {string} @@ -7351,6 +9130,11 @@ export interface components { * @enum {string} */ p24_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the Payco capability of the account, or whether the account can directly process Payco payments. + * @enum {string} + */ + payco_payments?: "active" | "inactive" | "pending"; /** * @description The status of the paynow payments capability of the account, or whether the account can directly process paynow charges. * @enum {string} @@ -7366,6 +9150,11 @@ export interface components { * @enum {string} */ revolut_pay_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments. + * @enum {string} + */ + samsung_pay_payments?: "active" | "inactive" | "pending"; /** * @description The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges. * @enum {string} @@ -7516,8 +9305,11 @@ export interface components { current_deadline?: number | null; /** @description Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. */ currently_due?: string[] | null; - /** @description This is typed as a string for consistency with `requirements.disabled_reason`. */ - disabled_reason?: string | null; + /** + * @description This is typed as an enum for consistency with `requirements.disabled_reason`. + * @enum {string|null} + */ + disabled_reason?: "action_required.requested_capabilities" | "listed" | "other" | "platform_paused" | "rejected.fraud" | "rejected.incomplete_verification" | "rejected.listed" | "rejected.other" | "rejected.platform_fraud" | "rejected.platform_other" | "rejected.platform_terms_of_service" | "rejected.terms_of_service" | "requirements.past_due" | "requirements.pending_verification" | "under_review" | null; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors?: components["schemas"]["account_requirements_error"][] | null; /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ @@ -7527,6 +9319,11 @@ export interface components { /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. */ pending_verification?: string[] | null; }; + /** AccountGroupMembership */ + account_group_membership: { + /** @description The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details. */ + payments_pricing?: string | null; + }; /** AccountInvoicesSettings */ account_invoices_settings: { /** @description The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized. */ @@ -7597,8 +9394,11 @@ export interface components { current_deadline?: number | null; /** @description Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. */ currently_due?: string[] | null; - /** @description If the account is disabled, this string describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). Can be `action_required.requested_capabilities`, `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.incomplete_verification`, `rejected.listed`, `rejected.other`, `rejected.terms_of_service`, `under_review`, or `other`. */ - disabled_reason?: string | null; + /** + * @description If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). + * @enum {string|null} + */ + disabled_reason?: "action_required.requested_capabilities" | "listed" | "other" | "platform_paused" | "rejected.fraud" | "rejected.incomplete_verification" | "rejected.listed" | "rejected.other" | "rejected.platform_fraud" | "rejected.platform_other" | "rejected.platform_terms_of_service" | "rejected.terms_of_service" | "requirements.past_due" | "requirements.pending_verification" | "under_review" | null; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors?: components["schemas"]["account_requirements_error"][] | null; /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ @@ -8250,8 +10050,6 @@ export interface components { * @enum {string} */ alert_type: "usage_threshold"; - /** @description Limits the scope of the alert to a specific [customer](https://stripe.com/docs/api/customers). */ - filter?: components["schemas"]["thresholds_resource_alert_filter"] | null; /** @description Unique identifier for the object. */ id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ @@ -8269,11 +10067,127 @@ export interface components { /** @description Title of the alert. */ title: string; /** @description Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter). */ - usage_threshold_config?: components["schemas"]["thresholds_resource_usage_threshold_config"] | null; + usage_threshold?: components["schemas"]["thresholds_resource_usage_threshold_config"] | null; + }; + /** + * CreditBalanceSummary + * @description Indicates the billing credit balance for billing credits granted to a customer. + */ + "billing.credit_balance_summary": { + /** @description The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry. */ + balances: components["schemas"]["credit_balance"][]; + /** @description The customer the balance is for. */ + customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; + /** @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; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "billing.credit_balance_summary"; + }; + /** + * CreditBalanceTransaction + * @description A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant. + */ + "billing.credit_balance_transaction": { + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + /** @description Credit details for this credit balance transaction. Only present if type is `credit`. */ + credit?: components["schemas"]["billing_credit_grants_resource_balance_credit"] | null; + /** @description The credit grant associated with this credit balance transaction. */ + credit_grant: string | components["schemas"]["billing.credit_grant"]; + /** @description Debit details for this credit balance transaction. Only present if type is `debit`. */ + debit?: components["schemas"]["billing_credit_grants_resource_balance_debit"] | null; + /** + * Format: unix-time + * @description The effective time of this credit balance transaction. + */ + effective_at: number; + /** @description Unique identifier for the object. */ + id: string; + /** @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; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "billing.credit_balance_transaction"; + /** @description ID of the test clock this credit balance transaction belongs to. */ + test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; + /** + * @description The type of credit balance transaction (credit or debit). + * @enum {string|null} + */ + type?: "credit" | "debit" | null; + }; + /** + * CreditGrant + * @description A credit grant is an API resource that documents the allocation of some billing credits to a customer. + * + * Related guide: [Billing credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits) + */ + "billing.credit_grant": { + amount: components["schemas"]["billing_credit_grants_resource_amount"]; + applicability_config: components["schemas"]["billing_credit_grants_resource_applicability_config"]; + /** + * @description The category of this credit grant. This is for tracking purposes and isn't displayed to the customer. + * @enum {string} + */ + category: "paid" | "promotional"; + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + /** @description ID of the customer receiving the billing credits. */ + customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; + /** + * Format: unix-time + * @description The time when the billing credits become effective—when they're eligible for use. + */ + effective_at?: number | null; + /** + * Format: unix-time + * @description The time when the billing credits expire. If not present, the billing credits don't expire. + */ + expires_at?: number | null; + /** @description Unique identifier for the object. */ + id: string; + /** @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; + /** @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. */ + metadata: { + [key: string]: string; + }; + /** @description A descriptive name shown in dashboard. */ + name?: string | null; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "billing.credit_grant"; + /** @description ID of the test clock this credit grant belongs to. */ + test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; + /** + * Format: unix-time + * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. + */ + updated: number; + /** + * Format: unix-time + * @description The time when this credit grant was voided. If not present, the credit grant hasn't been voided. + */ + voided_at?: number | null; }; /** * BillingMeter * @description A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make. + * + * Related guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based) */ "billing.meter": { /** @@ -8415,6 +10329,62 @@ export interface components { billing_clocks_resource_status_details_status_details: { advancing?: components["schemas"]["billing_clocks_resource_status_details_advancing_status_details"]; }; + /** BillingCreditGrantsResourceAmount */ + billing_credit_grants_resource_amount: { + /** @description The monetary amount. */ + monetary?: components["schemas"]["billing_credit_grants_resource_monetary_amount"] | null; + /** + * @description The type of this amount. We currently only support `monetary` billing credits. + * @enum {string} + */ + type: "monetary"; + }; + /** BillingCreditGrantsResourceApplicabilityConfig */ + billing_credit_grants_resource_applicability_config: { + scope: components["schemas"]["billing_credit_grants_resource_scope"]; + }; + /** BillingCreditGrantsResourceBalanceCredit */ + billing_credit_grants_resource_balance_credit: { + amount: components["schemas"]["billing_credit_grants_resource_amount"]; + /** + * @description The type of credit transaction. + * @enum {string} + */ + type: "credits_granted"; + }; + /** BillingCreditGrantsResourceBalanceCreditsApplied */ + billing_credit_grants_resource_balance_credits_applied: { + /** @description The invoice to which the billing credits were applied. */ + invoice: string | components["schemas"]["invoice"]; + /** @description The invoice line item to which the billing credits were applied. */ + invoice_line_item: string; + }; + /** BillingCreditGrantsResourceBalanceDebit */ + billing_credit_grants_resource_balance_debit: { + amount: components["schemas"]["billing_credit_grants_resource_amount"]; + /** @description Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`. */ + credits_applied?: components["schemas"]["billing_credit_grants_resource_balance_credits_applied"] | null; + /** + * @description The type of debit transaction. + * @enum {string} + */ + type: "credits_applied" | "credits_expired" | "credits_voided"; + }; + /** BillingCreditGrantsResourceMonetaryAmount */ + billing_credit_grants_resource_monetary_amount: { + /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + currency: string; + /** @description A positive integer representing the amount. */ + value: number; + }; + /** BillingCreditGrantsResourceScope */ + billing_credit_grants_resource_scope: { + /** + * @description The price type for which credit grants can apply. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. + * @enum {string} + */ + price_type: "metered"; + }; /** billing_details */ billing_details: { /** @description Billing address. */ @@ -8593,7 +10563,7 @@ export interface components { requested_at?: number | null; requirements?: components["schemas"]["account_capability_requirements"]; /** - * @description The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`. + * @description The status of the capability. * @enum {string} */ status: "active" | "disabled" | "inactive" | "pending" | "unrequested"; @@ -8883,6 +10853,8 @@ export interface components { * Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart) */ "checkout.session": { + /** @description Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). */ + adaptive_pricing?: components["schemas"]["payment_pages_checkout_session_adaptive_pricing"] | null; /** @description When set, provides configuration for actions to take if this Checkout Session expires. */ after_expiration?: components["schemas"]["payment_pages_checkout_session_after_expiration"] | null; /** @description Enables user redeemable promotion codes. */ @@ -9044,7 +11016,7 @@ export interface components { * specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used. * @enum {string|null} */ - submit_type?: "auto" | "book" | "donate" | "pay" | null; + submit_type?: "auto" | "book" | "donate" | "pay" | "subscribe" | null; /** @description The ID of the subscription for Checkout Sessions in `subscription` mode. */ subscription?: (string | components["schemas"]["subscription"]) | null; /** @description The URL the customer will be directed to after the payment or @@ -9178,6 +11150,7 @@ export interface components { }; /** CheckoutBacsDebitPaymentMethodOptions */ checkout_bacs_debit_payment_method_options: { + mandate_options?: components["schemas"]["checkout_payment_method_options_mandate_options_bacs_debit"]; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -9228,6 +11201,26 @@ export interface components { /** CheckoutCardPaymentMethodOptions */ checkout_card_payment_method_options: { installments?: components["schemas"]["checkout_card_installments_options"]; + /** + * @description Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession. + * @enum {string} + */ + request_extended_authorization?: "if_available" | "never"; + /** + * @description Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession. + * @enum {string} + */ + request_incremental_authorization?: "if_available" | "never"; + /** + * @description Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession. + * @enum {string} + */ + request_multicapture?: "if_available" | "never"; + /** + * @description Request ability to [overcapture](/payments/overcapture) for this CheckoutSession. + * @enum {string} + */ + request_overcapture?: "if_available" | "never"; /** * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string} @@ -9366,6 +11359,25 @@ export interface components { */ setup_future_usage?: "none"; }; + /** CheckoutKakaoPayPaymentMethodOptions */ + checkout_kakao_pay_payment_method_options: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + /** + * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. + * + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. + * + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). + * @enum {string} + */ + setup_future_usage?: "none" | "off_session"; + }; /** CheckoutKlarnaPaymentMethodOptions */ checkout_klarna_payment_method_options: { /** @@ -9396,6 +11408,25 @@ export interface components { */ setup_future_usage?: "none"; }; + /** CheckoutKrCardPaymentMethodOptions */ + checkout_kr_card_payment_method_options: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + /** + * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. + * + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. + * + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). + * @enum {string} + */ + setup_future_usage?: "none" | "off_session"; + }; /** CheckoutLinkPaymentMethodOptions */ checkout_link_payment_method_options: { /** @@ -9438,6 +11469,14 @@ export interface components { */ setup_future_usage?: "none"; }; + /** CheckoutNaverPayPaymentMethodOptions */ + checkout_naver_pay_payment_method_options: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + }; /** CheckoutOxxoPaymentMethodOptions */ checkout_oxxo_payment_method_options: { /** @description The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. */ @@ -9468,6 +11507,18 @@ export interface components { */ setup_future_usage?: "none"; }; + /** CheckoutPaycoPaymentMethodOptions */ + checkout_payco_payment_method_options: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + }; + /** checkout_payment_method_options_mandate_options_bacs_debit */ + checkout_payment_method_options_mandate_options_bacs_debit: Record; + /** checkout_payment_method_options_mandate_options_sepa_debit */ + checkout_payment_method_options_mandate_options_sepa_debit: Record; /** CheckoutPaynowPaymentMethodOptions */ checkout_paynow_payment_method_options: { /** @@ -9524,8 +11575,17 @@ export interface components { */ setup_future_usage?: "none" | "off_session"; }; + /** CheckoutSamsungPayPaymentMethodOptions */ + checkout_samsung_pay_payment_method_options: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + }; /** CheckoutSepaDebitPaymentMethodOptions */ checkout_sepa_debit_payment_method_options: { + mandate_options?: components["schemas"]["checkout_payment_method_options_mandate_options_sepa_debit"]; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -9557,17 +11617,22 @@ export interface components { giropay?: components["schemas"]["checkout_giropay_payment_method_options"]; grabpay?: components["schemas"]["checkout_grab_pay_payment_method_options"]; ideal?: components["schemas"]["checkout_ideal_payment_method_options"]; + kakao_pay?: components["schemas"]["checkout_kakao_pay_payment_method_options"]; klarna?: components["schemas"]["checkout_klarna_payment_method_options"]; konbini?: components["schemas"]["checkout_konbini_payment_method_options"]; + kr_card?: components["schemas"]["checkout_kr_card_payment_method_options"]; link?: components["schemas"]["checkout_link_payment_method_options"]; mobilepay?: components["schemas"]["checkout_mobilepay_payment_method_options"]; multibanco?: components["schemas"]["checkout_multibanco_payment_method_options"]; + naver_pay?: components["schemas"]["checkout_naver_pay_payment_method_options"]; oxxo?: components["schemas"]["checkout_oxxo_payment_method_options"]; p24?: components["schemas"]["checkout_p24_payment_method_options"]; + payco?: components["schemas"]["checkout_payco_payment_method_options"]; paynow?: components["schemas"]["checkout_paynow_payment_method_options"]; paypal?: components["schemas"]["checkout_paypal_payment_method_options"]; pix?: components["schemas"]["checkout_pix_payment_method_options"]; revolut_pay?: components["schemas"]["checkout_revolut_pay_payment_method_options"]; + samsung_pay?: components["schemas"]["checkout_samsung_pay_payment_method_options"]; sepa_debit?: components["schemas"]["checkout_sepa_debit_payment_method_options"]; sofort?: components["schemas"]["checkout_sofort_payment_method_options"]; swish?: components["schemas"]["checkout_swish_payment_method_options"]; @@ -9914,6 +11979,7 @@ export interface components { * @enum {string} */ allow_redisplay?: "always" | "limited" | "unspecified"; + alma?: components["schemas"]["payment_method_alma"]; amazon_pay?: components["schemas"]["payment_method_amazon_pay"]; au_becs_debit?: components["schemas"]["payment_method_au_becs_debit"]; bacs_debit?: components["schemas"]["payment_method_bacs_debit"]; @@ -9933,18 +11999,23 @@ export interface components { grabpay?: components["schemas"]["payment_method_grabpay"]; ideal?: components["schemas"]["payment_method_ideal"]; interac_present?: components["schemas"]["payment_method_interac_present"]; + kakao_pay?: components["schemas"]["payment_method_kakao_pay"]; klarna?: components["schemas"]["payment_method_klarna"]; konbini?: components["schemas"]["payment_method_konbini"]; + kr_card?: components["schemas"]["payment_method_kr_card"]; link?: components["schemas"]["payment_method_link"]; mobilepay?: components["schemas"]["payment_method_mobilepay"]; multibanco?: components["schemas"]["payment_method_multibanco"]; + naver_pay?: components["schemas"]["payment_method_naver_pay"]; oxxo?: components["schemas"]["payment_method_oxxo"]; p24?: components["schemas"]["payment_method_p24"]; + payco?: components["schemas"]["payment_method_payco"]; paynow?: components["schemas"]["payment_method_paynow"]; paypal?: components["schemas"]["payment_method_paypal"]; pix?: components["schemas"]["payment_method_pix"]; promptpay?: components["schemas"]["payment_method_promptpay"]; revolut_pay?: components["schemas"]["payment_method_revolut_pay"]; + samsung_pay?: components["schemas"]["payment_method_samsung_pay"]; sepa_debit?: components["schemas"]["payment_method_sepa_debit"]; sofort?: components["schemas"]["payment_method_sofort"]; swish?: components["schemas"]["payment_method_swish"]; @@ -9953,7 +12024,7 @@ export interface components { * @description The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. * @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; us_bank_account?: components["schemas"]["payment_method_us_bank_account"]; wechat_pay?: components["schemas"]["payment_method_wechat_pay"]; zip?: components["schemas"]["payment_method_zip"]; @@ -10002,7 +12073,9 @@ export interface components { }; /** ConnectEmbeddedAccountFeaturesClaim */ connect_embedded_account_features_claim: { - /** @description Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements. */ + /** @description Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise. */ + disable_stripe_user_authentication: boolean; + /** @description Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`. */ external_account_collection: boolean; }; /** ConnectEmbeddedAccountSessionCreateComponents */ @@ -10052,9 +12125,11 @@ export interface components { }; /** ConnectEmbeddedPayoutsFeatures */ connect_embedded_payouts_features: { + /** @description Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise. */ + disable_stripe_user_authentication: boolean; /** @description Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise. */ edit_payout_schedule: boolean; - /** @description Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements. */ + /** @description Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`. */ external_account_collection: boolean; /** @description Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise. */ instant_payouts: boolean; @@ -10171,6 +12246,11 @@ export interface components { /** @description Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. */ amount_off: number; }; + /** CreditBalance */ + credit_balance: { + available_balance: components["schemas"]["billing_credit_grants_resource_amount"]; + ledger_balance: components["schemas"]["billing_credit_grants_resource_amount"]; + }; /** * CreditNote * @description Issue a credit note to adjust an invoice's amount after the invoice is finalized. @@ -10242,6 +12322,8 @@ export interface components { out_of_band_amount?: number | null; /** @description The link to download the PDF of the credit note. */ pdf: string; + /** @description The pretax credit amounts (ex: discount, credit grants, etc) for all line items. */ + pretax_credit_amounts?: components["schemas"]["credit_notes_pretax_credit_amount"][]; /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string|null} @@ -10303,6 +12385,8 @@ export interface components { * @enum {string} */ object: "credit_note_line_item"; + /** @description The pretax credit amounts (ex: discount, credit grants, etc) for this line item. */ + pretax_credit_amounts?: components["schemas"]["credit_notes_pretax_credit_amount"][]; /** @description The number of units of product being credited. */ quantity?: number | null; /** @description The amount of tax calculated per tax rate for this line item */ @@ -10343,6 +12427,20 @@ export interface components { /** @description The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount?: number | null; }; + /** CreditNotesPretaxCreditAmount */ + credit_notes_pretax_credit_amount: { + /** @description The amount, in cents (or local equivalent), of the pretax credit amount. */ + amount: number; + /** @description The credit balance transaction that was applied to get this pretax credit amount. */ + credit_balance_transaction?: string | components["schemas"]["billing.credit_balance_transaction"]; + /** @description The discount that was applied to get this pretax credit amount. */ + discount?: string | components["schemas"]["discount"] | components["schemas"]["deleted_discount"]; + /** + * @description Type of the pretax credit amount referenced. + * @enum {string} + */ + type: "credit_balance_transaction" | "discount"; + }; /** CurrencyOption */ currency_option: { /** @description When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. */ @@ -10373,9 +12471,8 @@ export interface components { }; /** * 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) + * @description This object represents a customer of your business. Use it to [create recurring charges](https://stripe.com/docs/invoicing/customer), [save payment](https://stripe.com/docs/payments/save-during-payment) and contact information, + * and track payments that belong to the same customer. */ customer: { /** @description The customer's address. */ @@ -11297,6 +13394,8 @@ export interface components { created: number; /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ currency: string; + /** @description List of eligibility types that are included in `enhanced_evidence`. */ + enhanced_eligibility_types: "visa_compelling_evidence_3"[]; evidence: components["schemas"]["dispute_evidence"]; evidence_details: components["schemas"]["dispute_evidence_details"]; /** @description Unique identifier for the object. */ @@ -11325,6 +13424,31 @@ export interface components { */ status: "lost" | "needs_response" | "under_review" | "warning_closed" | "warning_needs_response" | "warning_under_review" | "won"; }; + /** DisputeEnhancedEligibility */ + dispute_enhanced_eligibility: { + visa_compelling_evidence_3?: components["schemas"]["dispute_enhanced_eligibility_visa_compelling_evidence3"]; + }; + /** DisputeEnhancedEligibilityVisaCompellingEvidence3 */ + dispute_enhanced_eligibility_visa_compelling_evidence3: { + /** @description List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission. */ + required_actions: ("missing_customer_identifiers" | "missing_disputed_transaction_description" | "missing_merchandise_or_services" | "missing_prior_undisputed_transaction_description" | "missing_prior_undisputed_transactions")[]; + /** + * @description Visa Compelling Evidence 3.0 eligibility status. + * @enum {string} + */ + status: "not_qualified" | "qualified" | "requires_action"; + }; + /** DisputeEnhancedEvidence */ + dispute_enhanced_evidence: { + visa_compelling_evidence_3?: components["schemas"]["dispute_enhanced_evidence_visa_compelling_evidence3"]; + }; + /** DisputeEnhancedEvidenceVisaCompellingEvidence3 */ + dispute_enhanced_evidence_visa_compelling_evidence3: { + /** @description Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission. */ + disputed_transaction?: components["schemas"]["dispute_visa_compelling_evidence3_disputed_transaction"] | null; + /** @description List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission. */ + prior_undisputed_transactions: components["schemas"]["dispute_visa_compelling_evidence3_prior_undisputed_transaction"][]; + }; /** DisputeEvidence */ dispute_evidence: { /** @description Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. */ @@ -11353,6 +13477,7 @@ export interface components { duplicate_charge_explanation?: string | null; /** @description The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. */ duplicate_charge_id?: string | null; + enhanced_evidence: components["schemas"]["dispute_enhanced_evidence"]; /** @description A description of the product or service that was sold. */ product_description?: string | null; /** @description (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge. */ @@ -11389,6 +13514,7 @@ export interface components { * @description Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute. */ due_by?: number | null; + enhanced_eligibility: components["schemas"]["dispute_enhanced_eligibility"]; /** @description Whether evidence has been staged for this dispute. */ has_evidence: boolean; /** @description Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed. */ @@ -11418,7 +13544,7 @@ export interface components { }; /** DisputePaymentMethodDetailsCard */ dispute_payment_method_details_card: { - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ brand: string; /** * @description The type of dispute opened. Different case types may have varying fees and financial impact. @@ -11440,6 +13566,62 @@ export interface components { /** @description The reason for the dispute as defined by PayPal */ reason_code?: string | null; }; + /** DisputeTransactionShippingAddress */ + dispute_transaction_shipping_address: { + /** @description City, district, suburb, town, or village. */ + city?: string | null; + /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + country?: string | null; + /** @description Address line 1 (e.g., street, PO Box, or company name). */ + line1?: string | null; + /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ + line2?: string | null; + /** @description ZIP or postal code. */ + postal_code?: string | null; + /** @description State, county, province, or region. */ + state?: string | null; + }; + /** DisputeVisaCompellingEvidence3DisputedTransaction */ + dispute_visa_compelling_evidence3_disputed_transaction: { + /** @description User Account ID used to log into business platform. Must be recognizable by the user. */ + customer_account_id?: string | null; + /** @description Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters. */ + customer_device_fingerprint?: string | null; + /** @description Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters. */ + customer_device_id?: string | null; + /** @description The email address of the customer. */ + customer_email_address?: string | null; + /** @description The IP address that the customer used when making the purchase. */ + customer_purchase_ip?: string | null; + /** + * @description Categorization of disputed payment. + * @enum {string|null} + */ + merchandise_or_services?: "merchandise" | "services" | null; + /** @description A description of the product or service that was sold. */ + product_description?: string | null; + /** @description The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission. */ + shipping_address?: components["schemas"]["dispute_transaction_shipping_address"] | null; + }; + /** DisputeVisaCompellingEvidence3PriorUndisputedTransaction */ + dispute_visa_compelling_evidence3_prior_undisputed_transaction: { + /** @description Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge. */ + charge: string; + /** @description User Account ID used to log into business platform. Must be recognizable by the user. */ + customer_account_id?: string | null; + /** @description Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters. */ + customer_device_fingerprint?: string | null; + /** @description Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters. */ + customer_device_id?: string | null; + /** @description The email address of the customer. */ + customer_email_address?: string | null; + /** @description The IP address that the customer used when making the purchase. */ + customer_purchase_ip?: string | null; + /** @description A description of the product or service that was sold. */ + product_description?: string | null; + /** @description The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission. */ + shipping_address?: components["schemas"]["dispute_transaction_shipping_address"] | null; + }; /** EmailSent */ email_sent: { /** @@ -11736,7 +13918,7 @@ export interface components { * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. * @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" | "issuing_regulatory_reporting" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; + purpose: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "document_provider_identity_document" | "finance_report_run" | "financial_account_statement" | "identity_document" | "identity_document_downloadable" | "issuing_regulatory_reporting" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; /** @description The size of the file object in bytes. */ size: number; /** @description A suitable title for the document. */ @@ -12103,6 +14285,10 @@ export interface components { id: string; /** @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; + /** @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. */ + metadata?: { + [key: string]: string; + } | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} @@ -12163,8 +14349,14 @@ export interface components { * @description ABA Records contain U.S. bank account details per the ABA format. */ funding_instructions_bank_transfer_aba_record: { + account_holder_address: components["schemas"]["address"]; + /** @description The account holder name */ + account_holder_name: string; /** @description The ABA account number */ account_number: string; + /** @description The account type */ + account_type: string; + bank_address: components["schemas"]["address"]; /** @description The bank name */ bank_name: string; /** @description The ABA routing number */ @@ -12232,8 +14424,14 @@ export interface components { * @description SWIFT Records contain U.S. bank account details per the SWIFT format. */ funding_instructions_bank_transfer_swift_record: { + account_holder_address: components["schemas"]["address"]; + /** @description The account holder name */ + account_holder_name: string; /** @description The account number */ account_number: string; + /** @description The account type */ + account_type: string; + bank_address: components["schemas"]["address"]; /** @description The bank name */ bank_name: string; /** @description The SWIFT code */ @@ -12610,7 +14808,7 @@ export interface components { * @enum {string} */ type: "document" | "id_number" | "verification_flow"; - /** @description The configuration token of a Verification Flow from the dashboard. */ + /** @description The configuration token of a verification flow from the dashboard. */ verification_flow?: string; /** @description ID of the VerificationSession that created this report. */ verification_session?: string | null; @@ -12676,7 +14874,7 @@ export interface components { type: "document" | "id_number" | "verification_flow"; /** @description The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe. */ url?: string | null; - /** @description The configuration token of a Verification Flow from the dashboard. */ + /** @description The configuration token of a verification flow from the dashboard. */ verification_flow?: string; /** @description The user’s verified data. */ verified_outputs?: components["schemas"]["gelato_verified_outputs"] | null; @@ -12984,6 +15182,8 @@ export interface components { total_discount_amounts?: components["schemas"]["discounts_resource_discount_amount"][] | null; /** @description The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax. */ total_excluding_tax?: number | null; + /** @description Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items. */ + total_pretax_credit_amounts?: components["schemas"]["invoices_resource_pretax_credit_amount"][] | null; /** @description The aggregate amounts calculated per tax rate for all line items. */ total_tax_amounts: components["schemas"]["invoice_tax_amount"][]; /** @description The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice. */ @@ -13333,7 +15533,7 @@ export interface components { /** @description Payment-method-specific configuration to provide to the invoice’s PaymentIntent. */ payment_method_options?: components["schemas"]["invoices_payment_method_options"] | null; /** @description The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). */ - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | null; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "p24" | "payco" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | null; }; /** InvoicesResourceFromInvoice */ invoices_resource_from_invoice: { @@ -13356,10 +15556,10 @@ export interface components { /** InvoicesResourceInvoiceTaxID */ invoices_resource_invoice_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; /** @description The value of the tax ID. */ value?: string | null; }; @@ -13375,6 +15575,20 @@ export interface components { /** @description For a credit proration `line_item`, the original debit line_items to which the credit proration applies. */ credited_items?: components["schemas"]["invoices_resource_line_items_credited_items"] | null; }; + /** InvoicesResourcePretaxCreditAmount */ + invoices_resource_pretax_credit_amount: { + /** @description The amount, in cents (or local equivalent), of the pretax credit amount. */ + amount: number; + /** @description The credit balance transaction that was applied to get this pretax credit amount. */ + credit_balance_transaction?: (string | components["schemas"]["billing.credit_balance_transaction"]) | null; + /** @description The discount that was applied to get this pretax credit amount. */ + discount?: string | components["schemas"]["discount"] | components["schemas"]["deleted_discount"]; + /** + * @description Type of the pretax credit amount referenced. + * @enum {string} + */ + type: "credit_balance_transaction" | "discount"; + }; /** InvoicesResourceShippingCost */ invoices_resource_shipping_cost: { /** @description Total shipping cost before any taxes are applied. */ @@ -13445,6 +15659,8 @@ export interface components { currency: string; /** @description Fleet-specific information for authorizations using Fleet cards. */ fleet?: components["schemas"]["issuing_authorization_fleet_data"] | null; + /** @description Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons. */ + fraud_challenges?: components["schemas"]["issuing_authorization_fraud_challenge"][] | null; /** @description Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. */ fuel?: components["schemas"]["issuing_authorization_fuel_data"] | null; /** @description Unique identifier for the object. */ @@ -13483,12 +15699,14 @@ export interface components { /** @description [Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts). */ treasury?: components["schemas"]["issuing_authorization_treasury"] | null; verification_data: components["schemas"]["issuing_authorization_verification_data"]; + /** @description Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant. */ + verified_by_fraud_challenge?: boolean | null; /** @description The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. */ wallet?: string | null; }; /** * IssuingCard - * @description You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders. + * @description You can [create physical or virtual cards](https://stripe.com/docs/issuing) that are issued to cardholders. */ "issuing.card": { /** @description The brand of the card. */ @@ -13562,7 +15780,7 @@ export interface components { * IssuingCardholder * @description An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards. * - * Related guide: [How to create a cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) + * Related guide: [How to create a cardholder](https://stripe.com/docs/issuing/cards/virtual/issue-cards#create-cardholder) */ "issuing.cardholder": { billing: components["schemas"]["issuing_cardholder_address"]; @@ -13988,6 +16206,24 @@ export interface components { */ national_amount_decimal?: string | null; }; + /** IssuingAuthorizationFraudChallenge */ + issuing_authorization_fraud_challenge: { + /** + * @description The method by which the fraud challenge was delivered to the cardholder. + * @enum {string} + */ + channel: "sms"; + /** + * @description The status of the fraud challenge. + * @enum {string} + */ + status: "expired" | "pending" | "rejected" | "undeliverable" | "verified"; + /** + * @description If the challenge is not deliverable, the reason why. + * @enum {string|null} + */ + undeliverable_reason?: "no_phone_number" | "unsupported_phone_number" | null; + }; /** IssuingAuthorizationFuelData */ issuing_authorization_fuel_data: { /** @description [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. */ @@ -15018,6 +17254,8 @@ export interface components { */ object: "line_item"; period: components["schemas"]["invoice_line_item_period"]; + /** @description Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item. */ + pretax_credit_amounts?: components["schemas"]["invoices_resource_pretax_credit_amount"][] | null; /** @description The price of the line item. */ price?: components["schemas"]["price"] | null; /** @description Whether this is a proration. */ @@ -15168,6 +17406,10 @@ export interface components { }; /** mandate_cashapp */ mandate_cashapp: Record; + /** mandate_kakao_pay */ + mandate_kakao_pay: Record; + /** mandate_kr_card */ + mandate_kr_card: Record; /** mandate_link */ mandate_link: Record; /** mandate_multi_use */ @@ -15180,6 +17422,8 @@ export interface components { bacs_debit?: components["schemas"]["mandate_bacs_debit"]; card?: components["schemas"]["card_mandate_payment_method_details"]; cashapp?: components["schemas"]["mandate_cashapp"]; + kakao_pay?: components["schemas"]["mandate_kakao_pay"]; + kr_card?: components["schemas"]["mandate_kr_card"]; link?: components["schemas"]["mandate_link"]; paypal?: components["schemas"]["mandate_paypal"]; revolut_pay?: components["schemas"]["mandate_revolut_pay"]; @@ -15349,10 +17593,14 @@ export interface components { }; /** PaymentFlowsAmountDetails */ payment_flows_amount_details: { - tip?: components["schemas"]["payment_flows_amount_details_resource_tip"]; + tip?: components["schemas"]["payment_flows_amount_details_client_resource_tip"]; }; - /** PaymentFlowsAmountDetailsResourceTip */ - payment_flows_amount_details_resource_tip: { + /** PaymentFlowsAmountDetailsClient */ + payment_flows_amount_details_client: { + tip?: components["schemas"]["payment_flows_amount_details_client_resource_tip"]; + }; + /** PaymentFlowsAmountDetailsClientResourceTip */ + payment_flows_amount_details_client_resource_tip: { /** @description Portion of the amount that corresponds to a tip. */ amount?: number; }; @@ -15438,6 +17686,25 @@ export interface components { */ type: "apple_pay" | "google_pay" | "samsung_pay" | "unknown"; }; + /** PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptions */ + payment_flows_private_payment_methods_kakao_pay_payment_method_options: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + /** + * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. + * + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. + * + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). + * @enum {string} + */ + setup_future_usage?: "none" | "off_session"; + }; /** PaymentFlowsPrivatePaymentMethodsKlarnaDOB */ payment_flows_private_payment_methods_klarna_dob: { /** @description The day of birth, between 1 and 31. */ @@ -15447,6 +17714,30 @@ export interface components { /** @description The four-digit year of birth. */ year?: number | null; }; + /** PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptions */ + payment_flows_private_payment_methods_naver_pay_payment_method_options: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + }; + /** PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptions */ + payment_flows_private_payment_methods_payco_payment_method_options: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + }; + /** PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptions */ + payment_flows_private_payment_methods_samsung_pay_payment_method_options: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + }; /** PaymentFlowsPrivatePaymentMethodsUsBankAccountLinkedAccountOptionsFilters */ payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters: { /** @description The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`. */ @@ -15471,7 +17762,7 @@ export interface components { amount: number; /** @description Amount that can be captured from this PaymentIntent. */ amount_capturable?: number; - amount_details?: components["schemas"]["payment_flows_amount_details"]; + amount_details?: components["schemas"]["payment_flows_amount_details"] | components["schemas"]["payment_flows_amount_details_client"]; /** @description Amount that this PaymentIntent collects. */ amount_received?: number; /** @description ID of the Connect application that created the PaymentIntent. */ @@ -15546,7 +17837,7 @@ 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. */ + /** @description Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) 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; @@ -15877,6 +18168,7 @@ export interface components { affirm?: components["schemas"]["payment_method_options_affirm"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; afterpay_clearpay?: components["schemas"]["payment_method_options_afterpay_clearpay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; alipay?: components["schemas"]["payment_method_options_alipay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; + alma?: components["schemas"]["payment_method_options_alma"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; amazon_pay?: components["schemas"]["payment_method_options_amazon_pay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; au_becs_debit?: components["schemas"]["payment_intent_payment_method_options_au_becs_debit"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; bacs_debit?: components["schemas"]["payment_intent_payment_method_options_bacs_debit"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; @@ -15893,18 +18185,23 @@ export interface components { grabpay?: components["schemas"]["payment_method_options_grabpay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; ideal?: components["schemas"]["payment_method_options_ideal"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; interac_present?: components["schemas"]["payment_method_options_interac_present"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; + kakao_pay?: components["schemas"]["payment_flows_private_payment_methods_kakao_pay_payment_method_options"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; klarna?: components["schemas"]["payment_method_options_klarna"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; konbini?: components["schemas"]["payment_method_options_konbini"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; + kr_card?: components["schemas"]["payment_method_options_kr_card"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; link?: components["schemas"]["payment_intent_payment_method_options_link"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; mobilepay?: components["schemas"]["payment_intent_payment_method_options_mobilepay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; multibanco?: components["schemas"]["payment_method_options_multibanco"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; + naver_pay?: components["schemas"]["payment_flows_private_payment_methods_naver_pay_payment_method_options"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; oxxo?: components["schemas"]["payment_method_options_oxxo"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; p24?: components["schemas"]["payment_method_options_p24"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; + payco?: components["schemas"]["payment_flows_private_payment_methods_payco_payment_method_options"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; paynow?: components["schemas"]["payment_method_options_paynow"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; paypal?: components["schemas"]["payment_method_options_paypal"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; pix?: components["schemas"]["payment_method_options_pix"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; promptpay?: components["schemas"]["payment_method_options_promptpay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; revolut_pay?: components["schemas"]["payment_method_options_revolut_pay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; + samsung_pay?: components["schemas"]["payment_flows_private_payment_methods_samsung_pay_payment_method_options"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; sepa_debit?: components["schemas"]["payment_intent_payment_method_options_sepa_debit"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; sofort?: components["schemas"]["payment_method_options_sofort"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; swish?: components["schemas"]["payment_intent_payment_method_options_swish"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; @@ -15993,7 +18290,7 @@ export interface components { * @description Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time. * @enum {string|null} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa" | null; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa" | null; /** * @description Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent. * @enum {string} @@ -16298,7 +18595,7 @@ export interface components { */ payment_method_collection: "always" | "if_required"; /** @description The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ - payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | null; + payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | null; phone_number_collection: components["schemas"]["payment_links_resource_phone_number_collection"]; /** @description Settings that restrict the usage of a payment link. */ restrictions?: components["schemas"]["payment_links_resource_restrictions"] | null; @@ -16310,7 +18607,7 @@ export interface components { * @description Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button. * @enum {string} */ - submit_type: "auto" | "book" | "donate" | "pay"; + submit_type: "auto" | "book" | "donate" | "pay" | "subscribe"; /** @description When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`. */ subscription_data?: components["schemas"]["payment_links_resource_subscription_data"] | null; tax_id_collection: components["schemas"]["payment_links_resource_tax_id_collection"]; @@ -16568,6 +18865,7 @@ export interface components { * @enum {string} */ allow_redisplay?: "always" | "limited" | "unspecified"; + alma?: components["schemas"]["payment_method_alma"]; amazon_pay?: components["schemas"]["payment_method_amazon_pay"]; au_becs_debit?: components["schemas"]["payment_method_au_becs_debit"]; bacs_debit?: components["schemas"]["payment_method_bacs_debit"]; @@ -16594,8 +18892,10 @@ export interface components { id: string; ideal?: components["schemas"]["payment_method_ideal"]; interac_present?: components["schemas"]["payment_method_interac_present"]; + kakao_pay?: components["schemas"]["payment_method_kakao_pay"]; klarna?: components["schemas"]["payment_method_klarna"]; konbini?: components["schemas"]["payment_method_konbini"]; + kr_card?: components["schemas"]["payment_method_kr_card"]; link?: components["schemas"]["payment_method_link"]; /** @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; @@ -16605,6 +18905,7 @@ export interface components { } | null; mobilepay?: components["schemas"]["payment_method_mobilepay"]; multibanco?: components["schemas"]["payment_method_multibanco"]; + naver_pay?: components["schemas"]["payment_method_naver_pay"]; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} @@ -16612,12 +18913,14 @@ export interface components { object: "payment_method"; oxxo?: components["schemas"]["payment_method_oxxo"]; p24?: components["schemas"]["payment_method_p24"]; + payco?: components["schemas"]["payment_method_payco"]; paynow?: components["schemas"]["payment_method_paynow"]; paypal?: components["schemas"]["payment_method_paypal"]; pix?: components["schemas"]["payment_method_pix"]; promptpay?: components["schemas"]["payment_method_promptpay"]; radar_options?: components["schemas"]["radar_radar_options"]; revolut_pay?: components["schemas"]["payment_method_revolut_pay"]; + samsung_pay?: components["schemas"]["payment_method_samsung_pay"]; sepa_debit?: components["schemas"]["payment_method_sepa_debit"]; sofort?: components["schemas"]["payment_method_sofort"]; swish?: components["schemas"]["payment_method_swish"]; @@ -16626,7 +18929,7 @@ export interface components { * @description The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. * @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; us_bank_account?: components["schemas"]["payment_method_us_bank_account"]; wechat_pay?: components["schemas"]["payment_method_wechat_pay"]; zip?: components["schemas"]["payment_method_zip"]; @@ -16648,6 +18951,8 @@ export interface components { payment_method_affirm: Record; /** payment_method_afterpay_clearpay */ payment_method_afterpay_clearpay: Record; + /** payment_method_alma */ + payment_method_alma: Record; /** payment_method_amazon_pay */ payment_method_amazon_pay: Record; /** payment_method_au_becs_debit */ @@ -16679,7 +18984,7 @@ export interface components { }; /** payment_method_card */ payment_method_card: { - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ brand: string; /** @description Checks on Card address and CVC if provided. */ checks?: components["schemas"]["payment_method_card_checks"] | null; @@ -16728,7 +19033,7 @@ export interface components { }; /** payment_method_card_present */ payment_method_card_present: { - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ brand?: string | null; /** @description The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. */ brand_product?: string | null; @@ -16880,6 +19185,7 @@ export interface components { 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"]; + alma?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; amazon_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; apple_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; /** @description For child configs, the Connect application associated with the configuration. */ @@ -16944,6 +19250,7 @@ export interface components { affirm?: components["schemas"]["payment_method_details_affirm"]; afterpay_clearpay?: components["schemas"]["payment_method_details_afterpay_clearpay"]; alipay?: components["schemas"]["payment_flows_private_payment_methods_alipay_details"]; + alma?: components["schemas"]["payment_method_details_alma"]; amazon_pay?: components["schemas"]["payment_method_details_amazon_pay"]; au_becs_debit?: components["schemas"]["payment_method_details_au_becs_debit"]; bacs_debit?: components["schemas"]["payment_method_details_bacs_debit"]; @@ -16960,18 +19267,23 @@ export interface components { grabpay?: components["schemas"]["payment_method_details_grabpay"]; ideal?: components["schemas"]["payment_method_details_ideal"]; interac_present?: components["schemas"]["payment_method_details_interac_present"]; + kakao_pay?: components["schemas"]["payment_method_details_kakao_pay"]; klarna?: components["schemas"]["payment_method_details_klarna"]; konbini?: components["schemas"]["payment_method_details_konbini"]; + kr_card?: components["schemas"]["payment_method_details_kr_card"]; link?: components["schemas"]["payment_method_details_link"]; mobilepay?: components["schemas"]["payment_method_details_mobilepay"]; multibanco?: components["schemas"]["payment_method_details_multibanco"]; + naver_pay?: components["schemas"]["payment_method_details_naver_pay"]; oxxo?: components["schemas"]["payment_method_details_oxxo"]; p24?: components["schemas"]["payment_method_details_p24"]; + payco?: components["schemas"]["payment_method_details_payco"]; paynow?: components["schemas"]["payment_method_details_paynow"]; paypal?: components["schemas"]["payment_method_details_paypal"]; pix?: components["schemas"]["payment_method_details_pix"]; promptpay?: components["schemas"]["payment_method_details_promptpay"]; revolut_pay?: components["schemas"]["payment_method_details_revolut_pay"]; + samsung_pay?: components["schemas"]["payment_method_details_samsung_pay"]; sepa_debit?: components["schemas"]["payment_method_details_sepa_debit"]; sofort?: components["schemas"]["payment_method_details_sofort"]; stripe_account?: components["schemas"]["payment_method_details_stripe_account"]; @@ -17042,6 +19354,8 @@ export interface components { /** @description Order identifier shown to the merchant in Afterpay’s online portal. */ reference?: string | null; }; + /** payment_method_details_alma */ + payment_method_details_alma: Record; /** payment_method_details_amazon_pay */ payment_method_details_amazon_pay: Record; /** payment_method_details_au_becs_debit */ @@ -17106,7 +19420,7 @@ export interface components { amount_authorized?: number | null; /** @description Authorization code on the charge. */ authorization_code?: string | null; - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ brand?: string | null; /** * Format: unix-time @@ -17138,7 +19452,7 @@ export interface components { /** @description ID of the mandate used to make this payment or created by it. */ mandate?: string | null; multicapture?: components["schemas"]["payment_flows_private_payment_methods_card_details_api_resource_multicapture"]; - /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ network?: string | null; /** @description If this card has network token credentials, this contains the details of the network token credentials. */ network_token?: components["schemas"]["payment_method_details_card_network_token"] | null; @@ -17187,7 +19501,7 @@ export interface components { payment_method_details_card_present: { /** @description The authorized amount */ amount_authorized?: number | null; - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ brand?: string | null; /** @description The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. */ brand_product?: string | null; @@ -17222,7 +19536,7 @@ export interface components { issuer?: string | null; /** @description The last four digits of the card. */ last4?: string | null; - /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ network?: string | null; /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ network_transaction_id?: string | null; @@ -17426,7 +19740,7 @@ export interface components { issuer?: string | null; /** @description The last four digits of the card. */ last4?: string | null; - /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ network?: string | null; /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ network_transaction_id?: string | null; @@ -17464,6 +19778,11 @@ export interface components { /** @description An indication of various EMV functions performed during the transaction. */ transaction_status_information?: string | null; }; + /** payment_method_details_kakao_pay */ + payment_method_details_kakao_pay: { + /** @description A unique identifier for the buyer as determined by the local payment processor. */ + buyer_id?: string | null; + }; /** payment_method_details_klarna */ payment_method_details_klarna: { /** @description The payer details for this transaction. */ @@ -17488,6 +19807,18 @@ export interface components { */ chain?: "familymart" | "lawson" | "ministop" | "seicomart" | null; }; + /** payment_method_details_kr_card */ + payment_method_details_kr_card: { + /** + * @description The local credit or debit card brand. + * @enum {string|null} + */ + brand?: "bc" | "citi" | "hana" | "hyundai" | "jeju" | "jeonbuk" | "kakaobank" | "kbank" | "kdbbank" | "kookmin" | "kwangju" | "lotte" | "mg" | "nh" | "post" | "samsung" | "savingsbank" | "shinhan" | "shinhyup" | "suhyup" | "tossbank" | "woori" | null; + /** @description A unique identifier for the buyer as determined by the local payment processor. */ + buyer_id?: string | null; + /** @description The last four digits of the card. This may not be present for American Express cards. */ + last4?: string | null; + }; /** payment_method_details_link */ payment_method_details_link: { /** @description Two-letter ISO code representing the funding source country beneath the Link payment. @@ -17506,6 +19837,11 @@ export interface components { /** @description Reference number associated with this Multibanco payment. */ reference?: string | null; }; + /** payment_method_details_naver_pay */ + payment_method_details_naver_pay: { + /** @description A unique identifier for the buyer as determined by the local payment processor. */ + buyer_id?: string | null; + }; /** payment_method_details_oxxo */ payment_method_details_oxxo: { /** @description OXXO reference number */ @@ -17525,6 +19861,11 @@ export interface components { * Przelewy24 rarely provides this information so the attribute is usually empty. */ verified_name?: string | null; }; + /** payment_method_details_payco */ + payment_method_details_payco: { + /** @description A unique identifier for the buyer as determined by the local payment processor. */ + buyer_id?: string | null; + }; /** payment_method_details_paynow */ payment_method_details_paynow: { /** @description Reference number associated with this PayNow payment */ @@ -17557,6 +19898,11 @@ export interface components { }; /** payment_method_details_revolut_pay */ payment_method_details_revolut_pay: Record; + /** payment_method_details_samsung_pay */ + payment_method_details_samsung_pay: { + /** @description A unique identifier for the buyer as determined by the local payment processor. */ + buyer_id?: string | null; + }; /** payment_method_details_sepa_debit */ payment_method_details_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ @@ -17655,6 +20001,7 @@ export interface components { * Related guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). */ payment_method_domain: { + amazon_pay: components["schemas"]["payment_method_domain_resource_payment_method_status"]; apple_pay: components["schemas"]["payment_method_domain_resource_payment_method_status"]; /** * Format: unix-time @@ -17765,6 +20112,8 @@ export interface components { */ read_method?: "contact_emv" | "contactless_emv" | "contactless_magstripe_mode" | "magnetic_stripe_fallback" | "magnetic_stripe_track2" | null; }; + /** payment_method_kakao_pay */ + payment_method_kakao_pay: Record; /** payment_method_klarna */ payment_method_klarna: { /** @description The customer's date of birth, if provided. */ @@ -17772,6 +20121,16 @@ export interface components { }; /** payment_method_konbini */ payment_method_konbini: Record; + /** payment_method_kr_card */ + payment_method_kr_card: { + /** + * @description The local credit or debit card brand. + * @enum {string|null} + */ + brand?: "bc" | "citi" | "hana" | "hyundai" | "jeju" | "jeonbuk" | "kakaobank" | "kbank" | "kdbbank" | "kookmin" | "kwangju" | "lotte" | "mg" | "nh" | "post" | "samsung" | "savingsbank" | "shinhan" | "shinhyup" | "suhyup" | "tossbank" | "woori" | null; + /** @description The last four digits of the card. This may not be present for American Express cards. */ + last4?: string | null; + }; /** payment_method_link */ payment_method_link: { /** @description Account owner's email address. */ @@ -17781,6 +20140,14 @@ export interface components { payment_method_mobilepay: Record; /** payment_method_multibanco */ payment_method_multibanco: Record; + /** payment_method_naver_pay */ + payment_method_naver_pay: { + /** + * @description Whether to fund this transaction with Naver Pay points or a card. + * @enum {string} + */ + funding: "card" | "points"; + }; /** payment_method_options_affirm */ payment_method_options_affirm: { /** @@ -17838,6 +20205,14 @@ export interface components { */ setup_future_usage?: "none" | "off_session"; }; + /** payment_method_options_alma */ + payment_method_options_alma: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + }; /** payment_method_options_amazon_pay */ payment_method_options_amazon_pay: { /** @@ -18114,6 +20489,25 @@ export interface components { */ setup_future_usage?: "none"; }; + /** payment_method_options_kr_card */ + payment_method_options_kr_card: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + /** + * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. + * + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. + * + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). + * @enum {string} + */ + setup_future_usage?: "none" | "off_session"; + }; /** payment_method_options_multibanco */ payment_method_options_multibanco: { /** @@ -18332,6 +20726,8 @@ export interface components { */ bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank" | null; }; + /** payment_method_payco */ + payment_method_payco: Record; /** payment_method_paynow */ payment_method_paynow: Record; /** payment_method_paypal */ @@ -18348,6 +20744,8 @@ export interface components { payment_method_promptpay: Record; /** payment_method_revolut_pay */ payment_method_revolut_pay: Record; + /** payment_method_samsung_pay */ + payment_method_samsung_pay: Record; /** payment_method_sepa_debit */ payment_method_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ @@ -18420,6 +20818,11 @@ export interface components { payment_method_wechat_pay: Record; /** payment_method_zip */ payment_method_zip: Record; + /** PaymentPagesCheckoutSessionAdaptivePricing */ + payment_pages_checkout_session_adaptive_pricing: { + /** @description Whether Adaptive Pricing is enabled. */ + enabled: boolean; + }; /** PaymentPagesCheckoutSessionAfterExpiration */ payment_pages_checkout_session_after_expiration: { /** @description When set, configuration used to recover the Checkout Session on expiry. */ @@ -18681,10 +21084,10 @@ export interface components { /** PaymentPagesCheckoutSessionTaxID */ payment_pages_checkout_session_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; /** @description The value of the tax ID. */ value?: string | null; }; @@ -18791,12 +21194,21 @@ export interface components { statement_descriptor?: string | null; /** @description Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`. */ status: string; + /** @description A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar. */ + trace_id?: components["schemas"]["payouts_trace_id"] | null; /** * @description Can be `bank_account` or `card`. * @enum {string} */ type: "bank_account" | "card"; }; + /** PayoutsTraceID */ + payouts_trace_id: { + /** @description Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`. */ + status: string; + /** @description The trace ID value if `trace_id.status` is `supported`, otherwise `nil`. */ + value?: string | null; + }; /** paypal_seller_protection */ paypal_seller_protection: { /** @description An array of conditions that are covered for the transaction, if applicable. */ @@ -18852,7 +21264,7 @@ export interface components { /** @description A list of alternate names or aliases that the person is known by. */ full_name_aliases?: string[]; future_requirements?: components["schemas"]["person_future_requirements"] | null; - /** @description The person's gender (International regulations require either "male" or "female"). */ + /** @description The person's gender. */ gender?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -19201,6 +21613,19 @@ export interface components { /** @description Whether the feature is enabled. */ enabled: boolean; }; + /** PortalResourceScheduleUpdateAtPeriodEnd */ + portal_resource_schedule_update_at_period_end: { + /** @description List of conditions. When any condition is true, an update will be scheduled at the end of the current period. */ + conditions: components["schemas"]["portal_resource_schedule_update_at_period_end_condition"][]; + }; + /** PortalResourceScheduleUpdateAtPeriodEndCondition */ + portal_resource_schedule_update_at_period_end_condition: { + /** + * @description The type of condition. + * @enum {string} + */ + type: "decreasing_item_amount" | "shortening_interval"; + }; /** PortalSubscriptionCancel */ portal_subscription_cancel: { cancellation_reason: components["schemas"]["portal_subscription_cancellation_reason"]; @@ -19237,6 +21662,7 @@ export interface components { * @enum {string} */ proration_behavior: "always_invoice" | "create_prorations" | "none"; + schedule_at_period_end?: components["schemas"]["portal_resource_schedule_update_at_period_end"]; }; /** PortalSubscriptionUpdateProduct */ portal_subscription_update_product: { @@ -19432,7 +21858,7 @@ export interface components { promotion_code: { /** @description Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. */ active: boolean; - /** @description The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. */ + /** @description The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9). */ code: string; coupon: components["schemas"]["coupon"]; /** @@ -19953,36 +22379,53 @@ export interface components { affirm?: components["schemas"]["destination_details_unimplemented"]; afterpay_clearpay?: components["schemas"]["destination_details_unimplemented"]; alipay?: components["schemas"]["destination_details_unimplemented"]; + alma?: components["schemas"]["destination_details_unimplemented"]; amazon_pay?: components["schemas"]["destination_details_unimplemented"]; au_bank_transfer?: components["schemas"]["destination_details_unimplemented"]; - blik?: components["schemas"]["refund_destination_details_generic"]; - br_bank_transfer?: components["schemas"]["refund_destination_details_generic"]; + blik?: components["schemas"]["refund_destination_details_blik"]; + br_bank_transfer?: components["schemas"]["refund_destination_details_br_bank_transfer"]; card?: components["schemas"]["refund_destination_details_card"]; cashapp?: components["schemas"]["destination_details_unimplemented"]; customer_cash_balance?: components["schemas"]["destination_details_unimplemented"]; eps?: components["schemas"]["destination_details_unimplemented"]; - eu_bank_transfer?: components["schemas"]["refund_destination_details_generic"]; - gb_bank_transfer?: components["schemas"]["refund_destination_details_generic"]; + eu_bank_transfer?: components["schemas"]["refund_destination_details_eu_bank_transfer"]; + gb_bank_transfer?: components["schemas"]["refund_destination_details_gb_bank_transfer"]; giropay?: components["schemas"]["destination_details_unimplemented"]; grabpay?: components["schemas"]["destination_details_unimplemented"]; - jp_bank_transfer?: components["schemas"]["refund_destination_details_generic"]; + jp_bank_transfer?: components["schemas"]["refund_destination_details_jp_bank_transfer"]; klarna?: components["schemas"]["destination_details_unimplemented"]; - multibanco?: components["schemas"]["refund_destination_details_generic"]; - mx_bank_transfer?: components["schemas"]["refund_destination_details_generic"]; - p24?: components["schemas"]["refund_destination_details_generic"]; + multibanco?: components["schemas"]["refund_destination_details_multibanco"]; + mx_bank_transfer?: components["schemas"]["refund_destination_details_mx_bank_transfer"]; + p24?: components["schemas"]["refund_destination_details_p24"]; paynow?: components["schemas"]["destination_details_unimplemented"]; paypal?: components["schemas"]["destination_details_unimplemented"]; pix?: components["schemas"]["destination_details_unimplemented"]; revolut?: components["schemas"]["destination_details_unimplemented"]; sofort?: components["schemas"]["destination_details_unimplemented"]; - swish?: components["schemas"]["refund_destination_details_generic"]; - th_bank_transfer?: components["schemas"]["refund_destination_details_generic"]; + swish?: components["schemas"]["refund_destination_details_swish"]; + th_bank_transfer?: components["schemas"]["refund_destination_details_th_bank_transfer"]; /** @description The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction. */ type: string; - us_bank_transfer?: components["schemas"]["refund_destination_details_generic"]; + us_bank_transfer?: components["schemas"]["refund_destination_details_us_bank_transfer"]; wechat_pay?: components["schemas"]["destination_details_unimplemented"]; zip?: components["schemas"]["destination_details_unimplemented"]; }; + /** refund_destination_details_blik */ + refund_destination_details_blik: { + /** @description For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. */ + network_decline_code?: string | null; + /** @description The reference assigned to the refund. */ + reference?: string | null; + /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + reference_status?: string | null; + }; + /** refund_destination_details_br_bank_transfer */ + refund_destination_details_br_bank_transfer: { + /** @description The reference assigned to the refund. */ + reference?: string | null; + /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + reference_status?: string | null; + }; /** refund_destination_details_card */ refund_destination_details_card: { /** @description Value of the reference number assigned to the refund. */ @@ -19997,8 +22440,66 @@ export interface components { */ type: "pending" | "refund" | "reversal"; }; - /** refund_destination_details_generic */ - refund_destination_details_generic: { + /** refund_destination_details_eu_bank_transfer */ + refund_destination_details_eu_bank_transfer: { + /** @description The reference assigned to the refund. */ + reference?: string | null; + /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + reference_status?: string | null; + }; + /** refund_destination_details_gb_bank_transfer */ + refund_destination_details_gb_bank_transfer: { + /** @description The reference assigned to the refund. */ + reference?: string | null; + /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + reference_status?: string | null; + }; + /** refund_destination_details_jp_bank_transfer */ + refund_destination_details_jp_bank_transfer: { + /** @description The reference assigned to the refund. */ + reference?: string | null; + /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + reference_status?: string | null; + }; + /** refund_destination_details_multibanco */ + refund_destination_details_multibanco: { + /** @description The reference assigned to the refund. */ + reference?: string | null; + /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + reference_status?: string | null; + }; + /** refund_destination_details_mx_bank_transfer */ + refund_destination_details_mx_bank_transfer: { + /** @description The reference assigned to the refund. */ + reference?: string | null; + /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + reference_status?: string | null; + }; + /** refund_destination_details_p24 */ + refund_destination_details_p24: { + /** @description The reference assigned to the refund. */ + reference?: string | null; + /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + reference_status?: string | null; + }; + /** refund_destination_details_swish */ + refund_destination_details_swish: { + /** @description For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. */ + network_decline_code?: string | null; + /** @description The reference assigned to the refund. */ + reference?: string | null; + /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + reference_status?: string | null; + }; + /** refund_destination_details_th_bank_transfer */ + refund_destination_details_th_bank_transfer: { + /** @description The reference assigned to the refund. */ + reference?: string | null; + /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + reference_status?: string | null; + }; + /** refund_destination_details_us_bank_transfer */ + refund_destination_details_us_bank_transfer: { /** @description The reference assigned to the refund. */ reference?: string | null; /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ @@ -20006,8 +22507,7 @@ export interface components { }; /** RefundNextAction */ refund_next_action: { - /** @description Contains the refund details. */ - display_details?: components["schemas"]["refund_next_action_display_details"] | null; + display_details?: components["schemas"]["refund_next_action_display_details"]; /** @description Type of the next action to perform. */ type: string; }; @@ -20308,7 +22808,9 @@ export interface components { card_present?: components["schemas"]["setup_attempt_payment_method_details_card_present"]; cashapp?: components["schemas"]["setup_attempt_payment_method_details_cashapp"]; ideal?: components["schemas"]["setup_attempt_payment_method_details_ideal"]; + kakao_pay?: components["schemas"]["setup_attempt_payment_method_details_kakao_pay"]; klarna?: components["schemas"]["setup_attempt_payment_method_details_klarna"]; + kr_card?: components["schemas"]["setup_attempt_payment_method_details_kr_card"]; link?: components["schemas"]["setup_attempt_payment_method_details_link"]; paypal?: components["schemas"]["setup_attempt_payment_method_details_paypal"]; revolut_pay?: components["schemas"]["setup_attempt_payment_method_details_revolut_pay"]; @@ -20354,7 +22856,7 @@ export interface components { setup_attempt_payment_method_details_boleto: Record; /** setup_attempt_payment_method_details_card */ setup_attempt_payment_method_details_card: { - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ brand?: string | null; /** @description Check results by Card networks on Card address and CVC at the time of authorization */ checks?: components["schemas"]["setup_attempt_payment_method_details_card_checks"] | null; @@ -20372,7 +22874,7 @@ export interface components { funding?: string | null; /** @description The last four digits of the card. */ last4?: string | null; - /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ network?: string | null; /** @description Populated if this authorization used 3D Secure authentication. */ three_d_secure?: components["schemas"]["three_d_secure_details"] | null; @@ -20429,8 +22931,12 @@ export interface components { * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ verified_name?: string | null; }; + /** setup_attempt_payment_method_details_kakao_pay */ + setup_attempt_payment_method_details_kakao_pay: Record; /** setup_attempt_payment_method_details_klarna */ setup_attempt_payment_method_details_klarna: Record; + /** setup_attempt_payment_method_details_kr_card */ + setup_attempt_payment_method_details_kr_card: Record; /** setup_attempt_payment_method_details_link */ setup_attempt_payment_method_details_link: Record; /** setup_attempt_payment_method_details_paypal */ @@ -20547,7 +23053,7 @@ export interface components { on_behalf_of?: (string | components["schemas"]["account"]) | null; /** @description ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead. */ payment_method?: (string | components["schemas"]["payment_method"]) | null; - /** @description Information about the payment method configuration used for this Setup Intent. */ + /** @description Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) 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; @@ -20637,7 +23143,7 @@ export interface components { * @description Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time. * @enum {string|null} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa" | null; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa" | null; /** * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} @@ -21448,7 +23954,7 @@ export interface components { object: "subscription"; /** @description The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details. */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment). */ + /** @description If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment). */ pause_collection?: components["schemas"]["subscriptions_resource_pause_collection"] | null; /** @description Payment settings passed on to invoices created by the subscription. */ payment_settings?: components["schemas"]["subscriptions_resource_payment_settings"] | null; @@ -21472,7 +23978,7 @@ export interface components { * * A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. * - * A subscription can only enter a `paused` status [when a trial ends without a payment method](/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. + * A subscription can only enter a `paused` status [when a trial ends without a payment method](https://stripe.com/docs/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. * * If subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). * @@ -21562,7 +24068,7 @@ export interface components { * @description Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time. * @enum {string|null} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa" | null; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa" | null; /** * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} @@ -21852,7 +24358,7 @@ export interface components { /** @description Payment-method-specific configuration to provide to invoices created by the subscription. */ payment_method_options?: components["schemas"]["subscriptions_resource_payment_method_options"] | null; /** @description The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). */ - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | null; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "p24" | "payco" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | null; /** * @description Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`. * @enum {string|null} @@ -22061,7 +24567,7 @@ export interface components { */ object: "tax.settings"; /** - * @description The `active` status indicates you have all required settings to calculate tax. A status can transition out of `active` when new required settings are introduced. + * @description The status of the Tax `Settings`. * @enum {string} */ status: "active" | "pending"; @@ -22260,10 +24766,10 @@ export interface components { /** @description The account or customer the tax ID belongs to. */ owner?: components["schemas"]["tax_i_ds_owner"] | null; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; /** @description Value of the tax ID. */ value: string; /** @description Tax ID verification information. */ @@ -22289,14 +24795,17 @@ export interface components { be?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; bg?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; bh?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + by?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; ca?: components["schemas"]["tax_product_registrations_resource_country_options_canada"]; ch?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; cl?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; co?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + cr?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; cy?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; cz?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; de?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; dk?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + ec?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; ee?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; eg?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; es?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; @@ -22318,6 +24827,8 @@ export interface components { lt?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; lu?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; lv?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + ma?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + md?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; mt?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; mx?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; my?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; @@ -22329,6 +24840,8 @@ export interface components { pl?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; pt?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; ro?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + rs?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + ru?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; sa?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; se?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; sg?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; @@ -22336,7 +24849,9 @@ export interface components { sk?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; th?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; tr?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + tz?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; us?: components["schemas"]["tax_product_registrations_resource_country_options_united_states"]; + uz?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; vn?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; za?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; }; @@ -22398,7 +24913,7 @@ export interface components { * @description Type of registration in the US. * @enum {string} */ - type: "local_amusement_tax" | "local_lease_tax" | "state_communications_tax" | "state_sales_tax"; + type: "local_amusement_tax" | "local_lease_tax" | "state_communications_tax" | "state_retail_delivery_fee" | "state_sales_tax"; }; /** TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax */ tax_product_registrations_resource_country_options_us_local_amusement_tax: { @@ -22447,10 +24962,10 @@ export interface components { /** TaxProductResourceCustomerDetailsResourceTaxId */ tax_product_resource_customer_details_resource_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; /** @description The value of the tax ID. */ value: string; }; @@ -22498,7 +25013,7 @@ export interface components { * @description The tax type, such as `vat` or `sales_tax`. * @enum {string} */ - tax_type: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; + tax_type: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "retail_delivery_fee" | "rst" | "sales_tax" | "service_tax" | "vat"; }; /** TaxProductResourcePostalAddress */ tax_product_resource_postal_address: { @@ -22556,15 +25071,22 @@ export interface components { tax_product_resource_tax_rate_details: { /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ country?: string | null; + /** @description The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. */ + flat_amount?: components["schemas"]["tax_rate_flat_amount"] | null; /** @description The tax rate percentage as a string. For example, 8.5% is represented as `"8.5"`. */ percentage_decimal: string; + /** + * @description Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. + * @enum {string|null} + */ + rate_type?: "flat_amount" | "percentage" | null; /** @description State, county, province, or region. */ state?: string | null; /** * @description The tax type, such as `vat` or `sales_tax`. * @enum {string|null} */ - tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "vat" | null; + tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "retail_delivery_fee" | "rst" | "sales_tax" | "service_tax" | "vat" | null; }; /** TaxProductResourceTaxSettingsDefaults */ tax_product_resource_tax_settings_defaults: { @@ -22642,6 +25164,8 @@ export interface components { * this percentage reflects the rate actually used to calculate tax based on the product's taxability * and whether the user is registered to collect taxes in the corresponding jurisdiction. */ effective_percentage?: number | null; + /** @description The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. */ + flat_amount?: components["schemas"]["tax_rate_flat_amount"] | null; /** @description Unique identifier for the object. */ id: string; /** @description This specifies if the tax rate is inclusive or exclusive. */ @@ -22666,13 +25190,28 @@ export interface components { object: "tax_rate"; /** @description Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions. */ percentage: number; + /** + * @description Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. + * @enum {string|null} + */ + rate_type?: "flat_amount" | "percentage" | null; /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ state?: string | null; /** * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string|null} */ - tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "vat" | null; + tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "retail_delivery_fee" | "rst" | "sales_tax" | "service_tax" | "vat" | null; + }; + /** + * TaxRateFlatAmount + * @description The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. + */ + tax_rate_flat_amount: { + /** @description Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ + amount: number; + /** @description Three-letter ISO currency code, in lowercase. */ + currency: string; }; /** * TerminalConfigurationConfiguration @@ -22824,6 +25363,7 @@ export interface components { myr?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; nok?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; nzd?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; + pln?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; sek?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; sgd?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; usd?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; @@ -23095,16 +25635,20 @@ export interface components { /** @description Whether 3D Secure is supported on this card. */ supported: boolean; }; - /** ThresholdsResourceAlertFilter */ - thresholds_resource_alert_filter: { + /** ThresholdsResourceUsageAlertFilter */ + thresholds_resource_usage_alert_filter: { /** @description Limit the scope of the alert to this customer ID */ customer?: (string | components["schemas"]["customer"]) | null; + /** @enum {string} */ + type: "customer"; }; /** * ThresholdsResourceUsageThresholdConfig * @description The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed. */ thresholds_resource_usage_threshold_config: { + /** @description The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time. */ + filters?: components["schemas"]["thresholds_resource_usage_alert_filter"][] | null; /** @description The value at which this alert will trigger. */ gte: number; /** @description The [Billing Meter](/api/billing/meter) ID whose usage is monitored. */ @@ -23513,7 +26057,7 @@ export interface components { /** @description The array of paths to restricted Features in the Features hash. */ restricted_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "financial_addresses.aba.forwarding" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; /** - * @description The enum specifying what state the account is in. + * @description Status of this FinancialAccount. * @enum {string} */ status: "closed" | "open"; @@ -23581,7 +26125,7 @@ export interface components { */ object: "treasury.inbound_transfer"; /** @description The origin payment method to be debited for an InboundTransfer. */ - origin_payment_method: string; + origin_payment_method?: string | null; /** @description Details about the PaymentMethod for an InboundTransfer. */ origin_payment_method_details?: components["schemas"]["inbound_transfers"] | null; /** @description Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state. */ @@ -23746,7 +26290,7 @@ export interface components { * @description Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen. * @enum {string|null} */ - failure_code?: "account_closed" | "account_frozen" | "other" | null; + failure_code?: "account_closed" | "account_frozen" | "international_transaction" | "other" | null; /** @description The FinancialAccount that received the funds. */ financial_account?: string | null; /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ @@ -24455,7 +26999,10 @@ export interface components { */ timestamp: number; }; - /** UsageRecordSummary */ + /** + * UsageRecordSummary + * @description A usage record summary represents an aggregated view of how much usage was accrued for a subscription item within a subscription billing period. + */ usage_record_summary: { /** @description Unique identifier for the object. */ id: string; @@ -24655,6 +27202,7 @@ export interface operations { enabled: boolean; /** account_features_param */ features?: { + disable_stripe_user_authentication?: boolean; external_account_collection?: boolean; }; }; @@ -24663,6 +27211,7 @@ export interface operations { enabled: boolean; /** account_features_param */ features?: { + disable_stripe_user_authentication?: boolean; external_account_collection?: boolean; }; }; @@ -24671,6 +27220,7 @@ export interface operations { enabled: boolean; /** payouts_features_param */ features?: { + disable_stripe_user_authentication?: boolean; edit_payout_schedule?: boolean; external_account_collection?: boolean; instant_payouts?: boolean; @@ -24688,6 +27238,7 @@ export interface operations { enabled: boolean; /** account_features_param */ features?: { + disable_stripe_user_authentication?: boolean; external_account_collection?: boolean; }; }; @@ -24718,6 +27269,7 @@ export interface operations { enabled: boolean; /** payouts_features_param */ features?: { + disable_stripe_user_authentication?: boolean; edit_payout_schedule?: boolean; external_account_collection?: boolean; instant_payouts?: boolean; @@ -24926,6 +27478,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + alma_payments?: { + requested?: boolean; + }; + /** capability_param */ amazon_pay_payments?: { requested?: boolean; }; @@ -25006,6 +27562,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + kakao_pay_payments?: { + requested?: boolean; + }; + /** capability_param */ klarna_payments?: { requested?: boolean; }; @@ -25014,6 +27574,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + kr_card_payments?: { + requested?: boolean; + }; + /** capability_param */ legacy_payments?: { requested?: boolean; }; @@ -25034,6 +27598,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + naver_pay_payments?: { + requested?: boolean; + }; + /** capability_param */ oxxo_payments?: { requested?: boolean; }; @@ -25042,6 +27610,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + payco_payments?: { + requested?: boolean; + }; + /** capability_param */ paynow_payments?: { requested?: boolean; }; @@ -25054,6 +27626,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + samsung_pay_payments?: { + requested?: boolean; + }; + /** capability_param */ sepa_bank_transfer_payments?: { requested?: boolean; }; @@ -25234,6 +27810,13 @@ export interface operations { expand?: string[]; /** @description A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.

    By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ external_account?: string; + /** + * account_groups_specs + * @description A hash of account group type to tokens. These are account groups this account should be added to + */ + groups?: { + payments_pricing?: string | ""; + }; /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. @@ -25551,6 +28134,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + alma_payments?: { + requested?: boolean; + }; + /** capability_param */ amazon_pay_payments?: { requested?: boolean; }; @@ -25631,6 +28218,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + kakao_pay_payments?: { + requested?: boolean; + }; + /** capability_param */ klarna_payments?: { requested?: boolean; }; @@ -25639,6 +28230,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + kr_card_payments?: { + requested?: boolean; + }; + /** capability_param */ legacy_payments?: { requested?: boolean; }; @@ -25659,6 +28254,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + naver_pay_payments?: { + requested?: boolean; + }; + /** capability_param */ oxxo_payments?: { requested?: boolean; }; @@ -25667,6 +28266,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + payco_payments?: { + requested?: boolean; + }; + /** capability_param */ paynow_payments?: { requested?: boolean; }; @@ -25679,6 +28282,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + samsung_pay_payments?: { + requested?: boolean; + }; + /** capability_param */ sepa_bank_transfer_payments?: { requested?: boolean; }; @@ -25834,6 +28441,13 @@ export interface operations { expand?: string[]; /** @description A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.

    By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ external_account?: string; + /** + * account_groups_specs + * @description A hash of account group type to tokens. These are account groups this account should be added to + */ + groups?: { + payments_pricing?: string | ""; + }; /** * individual_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. @@ -28831,7 +31445,417 @@ export interface operations { }; }; }; - PostBillingAlerts: { + PostBillingAlerts: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** + * @description The type of alert to create. + * @enum {string} + */ + alert_type: "usage_threshold"; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description The title of the alert. */ + title: string; + /** + * usage_threshold_config + * @description The configuration of the usage threshold. + */ + usage_threshold?: { + filters?: { + customer?: string; + /** @enum {string} */ + type: "customer"; + }[]; + gte: number; + meter?: string; + /** @enum {string} */ + recurrence: "one_time"; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.alert"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetBillingAlertsId: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.alert"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingAlertsIdActivate: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.alert"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingAlertsIdArchive: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.alert"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingAlertsIdDeactivate: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.alert"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetBillingCreditBalanceSummary: { + parameters: { + query: { + /** @description The customer for which to fetch credit balance summary. */ + customer: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description The filter criteria for the credit balance summary. */ + filter: { + /** scope_param */ + applicability_scope?: { + /** @enum {string} */ + price_type: "metered"; + }; + credit_grant?: string; + /** @enum {string} */ + type: "applicability_scope" | "credit_grant"; + }; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.credit_balance_summary"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetBillingCreditBalanceTransactions: { + parameters: { + query: { + /** @description The credit grant for which to fetch credit balance transactions. */ + credit_grant?: string; + /** @description The customer for which to fetch credit balance transactions. */ + customer: 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. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + 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 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; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["billing.credit_balance_transaction"][]; + /** @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: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetBillingCreditBalanceTransactionsId: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + /** @description Unique identifier for the object. */ + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.credit_balance_transaction"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetBillingCreditGrants: { + parameters: { + query?: { + /** @description Only return credit grants for this customer. */ + customer?: 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. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + 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 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; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["billing.credit_grant"][]; + /** @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: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingCreditGrants: { parameters: { query?: never; header?: never; @@ -28842,33 +31866,54 @@ export interface operations { content: { "application/x-www-form-urlencoded": { /** - * @description The type of alert to create. - * @enum {string} + * amount_param + * @description Amount of this credit grant. */ - alert_type: "usage_threshold"; - /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + amount: { + /** monetary_amount_param */ + monetary?: { + currency: string; + value: number; + }; + /** @enum {string} */ + type: "monetary"; + }; /** - * alert_filter - * @description Filters to limit the scope of an alert. + * applicability_config_param + * @description Configuration specifying what this credit grant applies to. */ - filter?: { - customer?: string; - subscription?: string; - subscription_item?: string; + applicability_config: { + /** scope_param */ + scope: { + /** @enum {string} */ + price_type: "metered"; + }; }; - /** @description The title of the alert. */ - title: string; /** - * usage_threshold_config - * @description The configuration of the usage threshold. + * @description The category of this credit grant. + * @enum {string} */ - usage_threshold_config?: { - gte: number; - meter?: string; - /** @enum {string} */ - recurrence: "one_time"; + category: "paid" | "promotional"; + /** @description ID of the customer to receive the billing credits. */ + customer: string; + /** + * Format: unix-time + * @description The time when the billing credits become effective—when they're eligible for use. Defaults to the current timestamp if not specified. + */ + effective_at?: number; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * Format: unix-time + * @description The time when the billing credits will expire. If not specified, the billing credits don't expire. + */ + expires_at?: number; + /** @description Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format. */ + metadata?: { + [key: string]: string; }; + /** @description A descriptive name shown in the Dashboard. */ + name?: string; }; }; }; @@ -28879,7 +31924,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["billing.alert"]; + "application/json": components["schemas"]["billing.credit_grant"]; }; }; /** @description Error response. */ @@ -28893,7 +31938,7 @@ export interface operations { }; }; }; - GetBillingAlertsId: { + GetBillingCreditGrantsId: { parameters: { query?: { /** @description Specifies which fields in the response should be expanded. */ @@ -28901,6 +31946,7 @@ export interface operations { }; header?: never; path: { + /** @description Unique identifier for the object. */ id: string; }; cookie?: never; @@ -28917,7 +31963,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["billing.alert"]; + "application/json": components["schemas"]["billing.credit_grant"]; }; }; /** @description Error response. */ @@ -28931,11 +31977,12 @@ export interface operations { }; }; }; - PostBillingAlertsIdActivate: { + PostBillingCreditGrantsId: { parameters: { query?: never; header?: never; path: { + /** @description Unique identifier for the object. */ id: string; }; cookie?: never; @@ -28945,6 +31992,12 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** @description The time when the billing credits created by this credit grant expire. If set to empty, the billing credits never expire. */ + expires_at?: number | ""; + /** @description Set of key-value pairs you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format. */ + metadata?: { + [key: string]: string; + }; }; }; }; @@ -28955,7 +32008,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["billing.alert"]; + "application/json": components["schemas"]["billing.credit_grant"]; }; }; /** @description Error response. */ @@ -28969,11 +32022,12 @@ export interface operations { }; }; }; - PostBillingAlertsIdArchive: { + PostBillingCreditGrantsIdExpire: { parameters: { query?: never; header?: never; path: { + /** @description Unique identifier for the object. */ id: string; }; cookie?: never; @@ -28993,7 +32047,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["billing.alert"]; + "application/json": components["schemas"]["billing.credit_grant"]; }; }; /** @description Error response. */ @@ -29007,11 +32061,12 @@ export interface operations { }; }; }; - PostBillingAlertsIdDeactivate: { + PostBillingCreditGrantsIdVoid: { parameters: { query?: never; header?: never; path: { + /** @description Unique identifier for the object. */ id: string; }; cookie?: never; @@ -29031,7 +32086,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["billing.alert"]; + "application/json": components["schemas"]["billing.credit_grant"]; }; }; /** @description Error response. */ @@ -29109,7 +32164,7 @@ export interface operations { event_name: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We'll enforce uniqueness within a rolling 24 hour period. */ + /** @description A unique identifier for the event. If not provided, one will be generated. We strongly advise using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations. */ identifier?: string; /** @description The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). */ payload: { @@ -29561,7 +32616,7 @@ export interface operations { * business_profile_create_param * @description The business information shown to customers in the portal. */ - business_profile: { + business_profile?: { headline?: string | ""; privacy_policy_url?: string; terms_of_service_url?: string; @@ -29603,14 +32658,21 @@ export interface operations { }; /** subscription_update_creation_param */ subscription_update?: { - default_allowed_updates: ("price" | "promotion_code" | "quantity")[] | ""; + default_allowed_updates?: ("price" | "promotion_code" | "quantity")[] | ""; enabled: boolean; - products: { + products?: { prices: string[]; product: string; }[] | ""; /** @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; + /** schedule_update_at_period_end_creating_param */ + schedule_at_period_end?: { + conditions?: { + /** @enum {string} */ + type: "decreasing_item_amount" | "shortening_interval"; + }[]; + }; }; }; /** @@ -29754,6 +32816,13 @@ export interface operations { }[] | ""; /** @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; + /** schedule_update_at_period_end_updating_param */ + schedule_at_period_end?: { + conditions?: { + /** @enum {string} */ + type: "decreasing_item_amount" | "shortening_interval"; + }[] | ""; + }; }; }; /** @@ -30379,6 +33448,49 @@ export interface operations { duplicate_charge_documentation?: string; duplicate_charge_explanation?: string; duplicate_charge_id?: string; + enhanced_evidence?: { + /** visa_compelling_evidence3 */ + visa_compelling_evidence_3?: { + /** visa_compelling_evidence3_disputed_transaction */ + disputed_transaction?: { + customer_account_id?: string | ""; + customer_device_fingerprint?: string | ""; + customer_device_id?: string | ""; + customer_email_address?: string | ""; + customer_purchase_ip?: string | ""; + /** @enum {string} */ + merchandise_or_services?: "merchandise" | "services"; + product_description?: string | ""; + /** shipping_address */ + shipping_address?: { + city?: string | ""; + country?: string | ""; + line1?: string | ""; + line2?: string | ""; + postal_code?: string | ""; + state?: string | ""; + }; + }; + prior_undisputed_transactions?: { + charge: string; + customer_account_id?: string | ""; + customer_device_fingerprint?: string | ""; + customer_device_id?: string | ""; + customer_email_address?: string | ""; + customer_purchase_ip?: string | ""; + product_description?: string | ""; + /** shipping_address */ + shipping_address?: { + city?: string | ""; + country?: string | ""; + line1?: string | ""; + line2?: string | ""; + postal_code?: string | ""; + state?: string | ""; + }; + }[]; + }; + } | ""; product_description?: string; receipt?: string; refund_policy?: string; @@ -30578,237 +33690,244 @@ export interface operations { }; }; }; - PostChargesChargeRefunds: { + PostChargesChargeRefunds: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The identifier of the charge to refund. */ + charge: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + amount?: number; + /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + currency?: string; + /** @description Customer whose customer balance to refund from. */ + customer?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions. */ + instructions_email?: string; + /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + metadata?: { + [key: string]: string; + } | ""; + /** + * @description Origin of the refund + * @enum {string} + */ + origin?: "customer_balance"; + /** @description The identifier of the PaymentIntent to refund. */ + payment_intent?: string; + /** + * @description String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms. + * @enum {string} + */ + reason?: "duplicate" | "fraudulent" | "requested_by_customer"; + /** @description Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. */ + refund_application_fee?: boolean; + /** @description Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).

    A transfer can be reversed only by the application that created the charge. */ + reverse_transfer?: boolean; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["refund"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetChargesChargeRefundsRefund: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + charge: string; + refund: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["refund"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostChargesChargeRefundsRefund: { + parameters: { + query?: never; + header?: never; + path: { + charge: string; + refund: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + metadata?: { + [key: string]: string; + } | ""; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["refund"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetCheckoutSessions: { + parameters: { + query?: { + /** @description Only return Checkout Sessions that were created during the given date interval. */ + created?: { + gt?: number; + gte?: number; + lt?: number; + lte?: number; + } | number; + /** @description Only return the Checkout Sessions for the Customer specified. */ + customer?: string; + /** @description Only return the Checkout Sessions for the Customer details specified. */ + customer_details?: { + email: 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. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + 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 Only return the Checkout Session for the PaymentIntent specified. */ + payment_intent?: string; + /** @description Only return the Checkout Sessions for the Payment Link specified. */ + payment_link?: string; + /** @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; + /** @description Only return the Checkout Sessions matching the given status. */ + status?: "complete" | "expired" | "open"; + /** @description Only return the Checkout Session for the subscription specified. */ + subscription?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["checkout.session"][]; + /** @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: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostCheckoutSessions: { parameters: { query?: never; header?: never; - path: { - /** @description The identifier of the charge to refund. */ - charge: string; - }; + path?: never; cookie?: never; }; requestBody?: { content: { "application/x-www-form-urlencoded": { - amount?: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ - currency?: string; - /** @description Customer whose customer balance to refund from. */ - customer?: string; - /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - /** @description For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions. */ - instructions_email?: string; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - metadata?: { - [key: string]: string; - } | ""; /** - * @description Origin of the refund - * @enum {string} - */ - origin?: "customer_balance"; - /** @description The identifier of the PaymentIntent to refund. */ - payment_intent?: string; - /** - * @description String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms. - * @enum {string} + * adaptive_pricing_params + * @description Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). */ - reason?: "duplicate" | "fraudulent" | "requested_by_customer"; - /** @description Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. */ - refund_application_fee?: boolean; - /** @description Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).

    A transfer can be reversed only by the application that created the charge. */ - reverse_transfer?: boolean; - }; - }; - }; - responses: { - /** @description Successful response. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["refund"]; - }; - }; - /** @description Error response. */ - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; - }; - GetChargesChargeRefundsRefund: { - parameters: { - query?: { - /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - header?: never; - path: { - charge: string; - refund: string; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/x-www-form-urlencoded": Record; - }; - }; - responses: { - /** @description Successful response. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["refund"]; - }; - }; - /** @description Error response. */ - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; - }; - PostChargesChargeRefundsRefund: { - parameters: { - query?: never; - header?: never; - path: { - charge: string; - refund: string; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/x-www-form-urlencoded": { - /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - metadata?: { - [key: string]: string; - } | ""; - }; - }; - }; - responses: { - /** @description Successful response. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["refund"]; - }; - }; - /** @description Error response. */ - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; - }; - GetCheckoutSessions: { - parameters: { - query?: { - /** @description Only return Checkout Sessions that were created during the given date interval. */ - created?: { - gt?: number; - gte?: number; - lt?: number; - lte?: number; - } | number; - /** @description Only return the Checkout Sessions for the Customer specified. */ - customer?: string; - /** @description Only return the Checkout Sessions for the Customer details specified. */ - customer_details?: { - email: 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. */ - ending_before?: string; - /** @description Specifies which fields in the response should be expanded. */ - 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 Only return the Checkout Session for the PaymentIntent specified. */ - payment_intent?: string; - /** @description Only return the Checkout Sessions for the Payment Link specified. */ - payment_link?: string; - /** @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; - /** @description Only return the Checkout Sessions matching the given status. */ - status?: "complete" | "expired" | "open"; - /** @description Only return the Checkout Session for the subscription specified. */ - subscription?: string; - }; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/x-www-form-urlencoded": Record; - }; - }; - responses: { - /** @description Successful response. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - data: components["schemas"]["checkout.session"][]; - /** @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; + adaptive_pricing?: { + enabled?: boolean; }; - }; - }; - /** @description Error response. */ - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; - }; - PostCheckoutSessions: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/x-www-form-urlencoded": { /** * after_expiration_params * @description Configure actions after a Checkout Session has expired. @@ -31168,6 +34287,8 @@ export interface operations { }; /** payment_method_options_param */ bacs_debit?: { + /** payment_method_options_mandate_options_param */ + mandate_options?: Record; /** @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; }; @@ -31189,6 +34310,14 @@ export interface operations { enabled?: boolean; }; /** @enum {string} */ + request_extended_authorization?: "if_available" | "never"; + /** @enum {string} */ + request_incremental_authorization?: "if_available" | "never"; + /** @enum {string} */ + request_multicapture?: "if_available" | "never"; + /** @enum {string} */ + request_overcapture?: "if_available" | "never"; + /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; /** @enum {string} */ setup_future_usage?: "off_session" | "on_session"; @@ -31243,6 +34372,13 @@ export interface operations { setup_future_usage?: "none"; }; /** payment_method_options_param */ + kakao_pay?: { + /** @enum {string} */ + capture_method?: "manual"; + /** @enum {string} */ + setup_future_usage?: "none" | "off_session"; + }; + /** payment_method_options_param */ klarna?: { /** @enum {string} */ setup_future_usage?: "none"; @@ -31254,6 +34390,13 @@ export interface operations { setup_future_usage?: "none"; }; /** payment_method_options_param */ + kr_card?: { + /** @enum {string} */ + capture_method?: "manual"; + /** @enum {string} */ + setup_future_usage?: "none" | "off_session"; + }; + /** payment_method_options_param */ link?: { /** @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -31269,6 +34412,13 @@ export interface operations { setup_future_usage?: "none"; }; /** payment_method_options_param */ + naver_pay?: { + /** @enum {string} */ + capture_method?: "manual"; + /** @enum {string} */ + setup_future_usage?: "none" | "off_session"; + }; + /** payment_method_options_param */ oxxo?: { expires_after_days?: number; /** @enum {string} */ @@ -31281,6 +34431,11 @@ export interface operations { tos_shown_and_accepted?: boolean; }; /** payment_method_options_param */ + payco?: { + /** @enum {string} */ + capture_method?: "manual"; + }; + /** payment_method_options_param */ paynow?: { /** @enum {string} */ setup_future_usage?: "none"; @@ -31306,7 +34461,14 @@ export interface operations { setup_future_usage?: "none" | "off_session"; }; /** payment_method_options_param */ + samsung_pay?: { + /** @enum {string} */ + capture_method?: "manual"; + }; + /** payment_method_options_param */ sepa_debit?: { + /** payment_method_options_mandate_options_param */ + mandate_options?: Record; /** @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; }; @@ -31351,7 +34513,7 @@ export interface operations { * If multiple payment methods are passed, Checkout will dynamically reorder them to * prioritize the most relevant payment methods based on the customer's location and * other characteristics. */ - payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[]; + payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[]; /** * phone_number_collection_params * @description Controls phone number collection settings for the session. @@ -31447,7 +34609,7 @@ export interface operations { * specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used. * @enum {string} */ - submit_type?: "auto" | "book" | "donate" | "pay"; + submit_type?: "auto" | "book" | "donate" | "pay" | "subscribe"; /** * subscription_data_params * @description A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode. @@ -33239,7 +36401,7 @@ export interface operations { promotion_code?: string; /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ shipping?: { - /** optional_fields_address */ + /** optional_fields_customer_address */ address: { city?: string; country?: string; @@ -33253,7 +36415,7 @@ export interface operations { } | ""; source?: string; /** - * tax_param + * shared_tax_create_param * @description Tax details about the customer. */ tax?: { @@ -33269,7 +36431,7 @@ export interface operations { /** @description The customer's tax IDs. */ tax_id_data?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; /** @description ID of the test clock to attach to the customer. */ @@ -33509,7 +36671,7 @@ export interface operations { promotion_code?: string; /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ shipping?: { - /** optional_fields_address */ + /** optional_fields_customer_address */ address: { city?: string; country?: string; @@ -33523,13 +36685,13 @@ export interface operations { } | ""; source?: string; /** - * tax_param + * shared_tax_update_param * @description Tax details about the customer. */ tax?: { ip_address?: string | ""; /** @enum {string} */ - validate_location?: "deferred" | "immediately"; + validate_location?: "auto" | "deferred" | "immediately"; }; /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. @@ -34735,7 +37897,7 @@ export interface operations { /** @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; /** @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. */ - type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; }; header?: never; path: { @@ -35403,7 +38565,7 @@ export interface operations { description?: string; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; @@ -35434,7 +38596,7 @@ export interface operations { verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "p24" | "payco" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; @@ -35689,7 +38851,7 @@ export interface operations { } | ""; /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session). */ off_session?: boolean; - /** @description If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment). */ + /** @description If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment). */ pause_collection?: { /** @enum {string} */ behavior: "keep_as_draft" | "mark_uncollectible" | "void"; @@ -35736,7 +38898,7 @@ export interface operations { description?: string; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; @@ -35767,7 +38929,7 @@ export interface operations { verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "p24" | "payco" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; @@ -36022,10 +39184,10 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; /** @description Value of the tax ID. */ value: string; }; @@ -36259,6 +39421,49 @@ export interface operations { duplicate_charge_documentation?: string; duplicate_charge_explanation?: string; duplicate_charge_id?: string; + enhanced_evidence?: { + /** visa_compelling_evidence3 */ + visa_compelling_evidence_3?: { + /** visa_compelling_evidence3_disputed_transaction */ + disputed_transaction?: { + customer_account_id?: string | ""; + customer_device_fingerprint?: string | ""; + customer_device_id?: string | ""; + customer_email_address?: string | ""; + customer_purchase_ip?: string | ""; + /** @enum {string} */ + merchandise_or_services?: "merchandise" | "services"; + product_description?: string | ""; + /** shipping_address */ + shipping_address?: { + city?: string | ""; + country?: string | ""; + line1?: string | ""; + line2?: string | ""; + postal_code?: string | ""; + state?: string | ""; + }; + }; + prior_undisputed_transactions?: { + charge: string; + customer_account_id?: string | ""; + customer_device_fingerprint?: string | ""; + customer_device_id?: string | ""; + customer_email_address?: string | ""; + customer_purchase_ip?: string | ""; + product_description?: string | ""; + /** shipping_address */ + shipping_address?: { + city?: string | ""; + country?: string | ""; + line1?: string | ""; + line2?: string | ""; + postal_code?: string | ""; + state?: string | ""; + }; + }[]; + }; + } | ""; product_description?: string; receipt?: string; refund_policy?: string; @@ -36983,7 +40188,7 @@ export interface operations { * @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`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`. */ + /** @description The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `financial_account_statement`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`. */ file: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { @@ -37112,7 +40317,7 @@ export interface operations { /** @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 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" | "issuing_regulatory_reporting" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; + purpose?: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "document_provider_identity_document" | "finance_report_run" | "financial_account_statement" | "identity_document" | "identity_document_downloadable" | "issuing_regulatory_reporting" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; /** @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; }; @@ -37845,6 +41050,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @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`. */ + metadata?: { + [key: string]: string; + }; /** @description The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed. */ payment_method: string; /** @description The field kinds to be replaced in the forwarded request. */ @@ -38140,7 +41349,7 @@ export interface operations { * @enum {string} */ type?: "document" | "id_number"; - /** @description The ID of a Verification Flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows. */ + /** @description The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows. */ verification_flow?: string; }; }; @@ -38959,6 +42168,11 @@ export interface operations { type: "account" | "self"; }; }; + /** + * Format: unix-time + * @description The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state. + */ + automatically_finalizes_at?: number; /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`. * @enum {string} @@ -39092,7 +42306,7 @@ export interface operations { verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "p24" | "payco" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; }; /** * @description How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted. @@ -39256,7 +42470,7 @@ export interface operations { state?: string; } | ""; shipping?: { - /** optional_fields_address */ + /** optional_fields_customer_address */ address: { city?: string; country?: string; @@ -39276,7 +42490,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; }; @@ -39632,7 +42846,7 @@ export interface operations { state?: string; } | ""; shipping?: { - /** optional_fields_address */ + /** optional_fields_customer_address */ address: { city?: string; country?: string; @@ -39652,7 +42866,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; }; @@ -40005,7 +43219,7 @@ export interface operations { state?: string; } | ""; shipping?: { - /** optional_fields_address */ + /** optional_fields_customer_address */ address: { city?: string; country?: string; @@ -40025,7 +43239,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; }; @@ -40435,6 +43649,11 @@ export interface operations { type: "account" | "self"; }; }; + /** + * Format: unix-time + * @description The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state. To turn off automatic finalization, set `auto_advance` to false. + */ + automatically_finalizes_at?: number; /** * @description Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices. * @enum {string} @@ -40552,7 +43771,7 @@ export interface operations { verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "p24" | "payco" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; }; /** * rendering_param @@ -40765,7 +43984,7 @@ export interface operations { percentage: number; state?: string; /** @enum {string} */ - tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; + tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "retail_delivery_fee" | "rst" | "sales_tax" | "service_tax" | "vat"; }; taxable_amount: number; }[] | ""; @@ -40974,7 +44193,7 @@ export interface operations { percentage: number; state?: string; /** @enum {string} */ - tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; + tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "retail_delivery_fee" | "rst" | "sales_tax" | "service_tax" | "vat"; }; taxable_amount: number; }[] | ""; @@ -41253,7 +44472,7 @@ export interface operations { percentage: number; state?: string; /** @enum {string} */ - tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; + tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "retail_delivery_fee" | "rst" | "sales_tax" | "service_tax" | "vat"; }; taxable_amount: number; }[] | ""; @@ -42024,7 +45243,7 @@ export interface operations { * @enum {string} */ replacement_reason?: "damaged" | "expired" | "lost" | "stolen"; - /** @description The second line to print on the card. */ + /** @description The second line to print on the card. Max length: 24 characters. */ second_line?: string | ""; /** * shipping_specs @@ -43847,7 +47066,7 @@ export interface operations { * * If you omit this parameter with `confirm=true`, `customer.default_source` attaches as this PaymentIntent's payment instrument to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward. */ payment_method?: string; - /** @description The ID of the payment method configuration to use with this PaymentIntent. */ + /** @description The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent. */ payment_method_configuration?: string; /** * payment_method_data_params @@ -43871,6 +47090,8 @@ export interface operations { /** @enum {string} */ allow_redisplay?: "always" | "limited" | "unspecified"; /** param */ + alma?: Record; + /** param */ amazon_pay?: Record; /** param */ au_becs_debit?: { @@ -43930,6 +47151,8 @@ export interface operations { /** param */ interac_present?: Record; /** param */ + kakao_pay?: Record; + /** param */ klarna?: { /** date_of_birth */ dob?: { @@ -43941,6 +47164,8 @@ export interface operations { /** param */ konbini?: Record; /** param */ + kr_card?: Record; + /** param */ link?: Record; metadata?: { [key: string]: string; @@ -43950,6 +47175,11 @@ export interface operations { /** param */ multibanco?: Record; /** param */ + naver_pay?: { + /** @enum {string} */ + funding?: "card" | "points"; + }; + /** param */ oxxo?: Record; /** param */ p24?: { @@ -43957,6 +47187,8 @@ export interface operations { bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ + payco?: Record; + /** param */ paynow?: Record; /** param */ paypal?: Record; @@ -43971,6 +47203,8 @@ export interface operations { /** param */ revolut_pay?: Record; /** param */ + samsung_pay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -43984,7 +47218,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -44038,6 +47272,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + alma?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; amazon_pay?: { /** @enum {string} */ capture_method?: "" | "manual"; @@ -44102,7 +47340,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_extended_authorization?: "if_available" | "never"; /** @enum {string} */ @@ -44195,6 +47433,12 @@ export interface operations { setup_future_usage?: "" | "none" | "off_session"; } | ""; interac_present?: Record | ""; + kakao_pay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; klarna?: { /** @enum {string} */ capture_method?: "" | "manual"; @@ -44211,6 +47455,12 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "none"; } | ""; + kr_card?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; link?: { /** @enum {string} */ capture_method?: "" | "manual"; @@ -44227,6 +47477,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "none"; } | ""; + naver_pay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; oxxo?: { expires_after_days?: number; /** @enum {string} */ @@ -44237,6 +47491,10 @@ export interface operations { setup_future_usage?: "none"; tos_shown_and_accepted?: boolean; } | ""; + payco?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; paynow?: { /** @enum {string} */ setup_future_usage?: "none"; @@ -44268,6 +47526,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + samsung_pay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; sepa_debit?: { /** payment_method_options_mandate_options_param */ mandate_options?: Record; @@ -44328,7 +47590,7 @@ export interface operations { setup_future_usage?: "none"; } | ""; }; - /** @description The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, it defaults to ["card"]. 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, a card) that this PaymentIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ payment_method_types?: string[]; /** * radar_options_with_hidden_options @@ -44547,7 +47809,7 @@ 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. To unset this field to null, pass in an empty string. */ payment_method?: string; - /** @description The ID of the payment method configuration to use with this PaymentIntent. */ + /** @description The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent. */ payment_method_configuration?: string; /** * payment_method_data_params @@ -44571,6 +47833,8 @@ export interface operations { /** @enum {string} */ allow_redisplay?: "always" | "limited" | "unspecified"; /** param */ + alma?: Record; + /** param */ amazon_pay?: Record; /** param */ au_becs_debit?: { @@ -44630,6 +47894,8 @@ export interface operations { /** param */ interac_present?: Record; /** param */ + kakao_pay?: Record; + /** param */ klarna?: { /** date_of_birth */ dob?: { @@ -44641,6 +47907,8 @@ export interface operations { /** param */ konbini?: Record; /** param */ + kr_card?: Record; + /** param */ link?: Record; metadata?: { [key: string]: string; @@ -44650,6 +47918,11 @@ export interface operations { /** param */ multibanco?: Record; /** param */ + naver_pay?: { + /** @enum {string} */ + funding?: "card" | "points"; + }; + /** param */ oxxo?: Record; /** param */ p24?: { @@ -44657,6 +47930,8 @@ export interface operations { bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ + payco?: Record; + /** param */ paynow?: Record; /** param */ paypal?: Record; @@ -44671,6 +47946,8 @@ export interface operations { /** param */ revolut_pay?: Record; /** param */ + samsung_pay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -44684,7 +47961,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -44738,6 +48015,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + alma?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; amazon_pay?: { /** @enum {string} */ capture_method?: "" | "manual"; @@ -44802,7 +48083,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_extended_authorization?: "if_available" | "never"; /** @enum {string} */ @@ -44895,6 +48176,12 @@ export interface operations { setup_future_usage?: "" | "none" | "off_session"; } | ""; interac_present?: Record | ""; + kakao_pay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; klarna?: { /** @enum {string} */ capture_method?: "" | "manual"; @@ -44911,6 +48198,12 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "none"; } | ""; + kr_card?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; link?: { /** @enum {string} */ capture_method?: "" | "manual"; @@ -44927,6 +48220,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "none"; } | ""; + naver_pay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; oxxo?: { expires_after_days?: number; /** @enum {string} */ @@ -44937,6 +48234,10 @@ export interface operations { setup_future_usage?: "none"; tos_shown_and_accepted?: boolean; } | ""; + payco?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; paynow?: { /** @enum {string} */ setup_future_usage?: "none"; @@ -44968,6 +48269,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + samsung_pay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; sepa_debit?: { /** payment_method_options_mandate_options_param */ mandate_options?: Record; @@ -45112,11 +48417,9 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. + /** @description Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. If the PaymentIntent was created by an Invoice, the full amount of the PaymentIntent is applied regardless of this parameter. * - * A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). - * - * The maximum amount is the amount of the PaymentIntent. + * A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent. * * When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent. */ amount?: number; @@ -45335,6 +48638,8 @@ export interface operations { /** @enum {string} */ allow_redisplay?: "always" | "limited" | "unspecified"; /** param */ + alma?: Record; + /** param */ amazon_pay?: Record; /** param */ au_becs_debit?: { @@ -45394,6 +48699,8 @@ export interface operations { /** param */ interac_present?: Record; /** param */ + kakao_pay?: Record; + /** param */ klarna?: { /** date_of_birth */ dob?: { @@ -45405,6 +48712,8 @@ export interface operations { /** param */ konbini?: Record; /** param */ + kr_card?: Record; + /** param */ link?: Record; metadata?: { [key: string]: string; @@ -45414,6 +48723,11 @@ export interface operations { /** param */ multibanco?: Record; /** param */ + naver_pay?: { + /** @enum {string} */ + funding?: "card" | "points"; + }; + /** param */ oxxo?: Record; /** param */ p24?: { @@ -45421,6 +48735,8 @@ export interface operations { bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ + payco?: Record; + /** param */ paynow?: Record; /** param */ paypal?: Record; @@ -45435,6 +48751,8 @@ export interface operations { /** param */ revolut_pay?: Record; /** param */ + samsung_pay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -45448,7 +48766,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -45502,6 +48820,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + alma?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; amazon_pay?: { /** @enum {string} */ capture_method?: "" | "manual"; @@ -45566,7 +48888,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_extended_authorization?: "if_available" | "never"; /** @enum {string} */ @@ -45659,6 +48981,12 @@ export interface operations { setup_future_usage?: "" | "none" | "off_session"; } | ""; interac_present?: Record | ""; + kakao_pay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; klarna?: { /** @enum {string} */ capture_method?: "" | "manual"; @@ -45675,6 +49003,12 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "none"; } | ""; + kr_card?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; link?: { /** @enum {string} */ capture_method?: "" | "manual"; @@ -45691,6 +49025,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "none"; } | ""; + naver_pay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; oxxo?: { expires_after_days?: number; /** @enum {string} */ @@ -45701,6 +49039,10 @@ export interface operations { setup_future_usage?: "none"; tos_shown_and_accepted?: boolean; } | ""; + payco?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; paynow?: { /** @enum {string} */ setup_future_usage?: "none"; @@ -45732,6 +49074,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + samsung_pay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; sepa_debit?: { /** payment_method_options_mandate_options_param */ mandate_options?: Record; @@ -46217,7 +49563,7 @@ export interface operations { */ payment_method_collection?: "always" | "if_required"; /** @description The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)). */ - payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[]; + payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[]; /** * phone_number_collection_params * @description Controls phone number collection settings during checkout. @@ -46252,7 +49598,7 @@ export interface operations { * @description Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`). * @enum {string} */ - submit_type?: "auto" | "book" | "donate" | "pay"; + submit_type?: "auto" | "book" | "donate" | "pay" | "subscribe"; /** * subscription_data_params * @description When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`. @@ -46535,7 +49881,7 @@ export interface operations { */ payment_method_collection?: "always" | "if_required"; /** @description The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ - payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | ""; + payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | ""; /** @description Settings that restrict the usage of a payment link. */ restrictions?: { /** completed_sessions_params */ @@ -46547,6 +49893,11 @@ export interface operations { shipping_address_collection?: { allowed_countries: ("AC" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CV" | "CW" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MK" | "ML" | "MM" | "MN" | "MO" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TA" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | "ZZ")[]; } | ""; + /** + * @description Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`). + * @enum {string} + */ + submit_type?: "auto" | "book" | "donate" | "pay" | "subscribe"; /** * subscription_data_update_params * @description When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`. @@ -46770,6 +50121,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments. + */ + alma?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** * payment_method_param * @description Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon. @@ -47152,7 +50514,7 @@ export interface operations { }; /** * 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. + * @description Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-direct-debit) for more details. */ us_bank_account?: { /** display_preference_param */ @@ -47303,6 +50665,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments. + */ + alma?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** * payment_method_param * @description Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon. @@ -47683,7 +51056,7 @@ export interface operations { }; /** * 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. + * @description Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-direct-debit) for more details. */ us_bank_account?: { /** display_preference_param */ @@ -47965,7 +51338,7 @@ export interface operations { /** @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; /** @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. */ - type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; }; header?: never; path?: never; @@ -48047,6 +51420,11 @@ export interface operations { * @enum {string} */ allow_redisplay?: "always" | "limited" | "unspecified"; + /** + * param + * @description If this is a Alma PaymentMethod, this hash contains details about the Alma payment method. + */ + alma?: Record; /** * param * @description If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method. @@ -48169,6 +51547,11 @@ export interface operations { * @description If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method. */ interac_present?: Record; + /** + * param + * @description If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method. + */ + kakao_pay?: Record; /** * param * @description If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method. @@ -48186,6 +51569,11 @@ export interface operations { * @description If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method. */ konbini?: Record; + /** + * param + * @description If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method. + */ + kr_card?: Record; /** * param * @description If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. @@ -48205,6 +51593,14 @@ export interface operations { * @description If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method. */ multibanco?: Record; + /** + * param + * @description If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method. + */ + naver_pay?: { + /** @enum {string} */ + funding?: "card" | "points"; + }; /** * param * @description If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. @@ -48218,6 +51614,11 @@ export interface operations { /** @enum {string} */ bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; + /** + * param + * @description If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method. + */ + payco?: Record; /** @description The PaymentMethod to share. */ payment_method?: string; /** @@ -48252,6 +51653,11 @@ export interface operations { * @description If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method. */ revolut_pay?: Record; + /** + * param + * @description If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method. + */ + samsung_pay?: Record; /** * param * @description If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. @@ -48281,7 +51687,7 @@ export interface operations { * @description The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. * @enum {string} */ - type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** * payment_method_param * @description If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method. @@ -48425,6 +51831,14 @@ export interface operations { metadata?: { [key: string]: string; } | ""; + /** + * param + * @description If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method. + */ + naver_pay?: { + /** @enum {string} */ + funding?: "card" | "points"; + }; /** * update_param * @description If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method. @@ -49656,6 +53070,13 @@ export interface operations { unit_amount_decimal?: string; }; }; + /** custom_unit_amount */ + custom_unit_amount?: { + enabled: boolean; + maximum?: number; + minimum?: number; + preset?: number; + }; /** recurring_adhoc */ recurring?: { /** @enum {string} */ @@ -50188,7 +53609,9 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Whether the promotion code is currently active. */ active?: boolean; - /** @description The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically. */ + /** @description The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9). + * + * If left blank, we will generate one automatically. */ code?: string; /** @description The coupon for this promotion code. */ coupon: string; @@ -52335,7 +55758,7 @@ 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 SetupIntent. */ + /** @description The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent. */ payment_method_configuration?: string; /** * payment_method_data_params @@ -52358,6 +55781,8 @@ export interface operations { /** @enum {string} */ allow_redisplay?: "always" | "limited" | "unspecified"; /** param */ + alma?: Record; + /** param */ amazon_pay?: Record; /** param */ au_becs_debit?: { @@ -52417,6 +55842,8 @@ export interface operations { /** param */ interac_present?: Record; /** param */ + kakao_pay?: Record; + /** param */ klarna?: { /** date_of_birth */ dob?: { @@ -52428,6 +55855,8 @@ export interface operations { /** param */ konbini?: Record; /** param */ + kr_card?: Record; + /** param */ link?: Record; metadata?: { [key: string]: string; @@ -52437,6 +55866,11 @@ export interface operations { /** param */ multibanco?: Record; /** param */ + naver_pay?: { + /** @enum {string} */ + funding?: "card" | "points"; + }; + /** param */ oxxo?: Record; /** param */ p24?: { @@ -52444,6 +55878,8 @@ export interface operations { bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ + payco?: Record; + /** param */ paynow?: Record; /** param */ paypal?: Record; @@ -52458,6 +55894,8 @@ export interface operations { /** param */ revolut_pay?: Record; /** param */ + samsung_pay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -52471,7 +55909,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -52536,7 +55974,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; /** setup_intent_payment_method_options_param */ @@ -52600,7 +56038,7 @@ export interface operations { verification_method?: "automatic" | "instant" | "microdeposits"; }; }; - /** @description The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, it defaults to ["card"]. */ + /** @description The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ payment_method_types?: string[]; /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). */ return_url?: string; @@ -52717,7 +56155,7 @@ export interface operations { } | ""; /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. To unset this field to null, pass in an empty string. */ payment_method?: string; - /** @description The ID of the payment method configuration to use with this SetupIntent. */ + /** @description The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent. */ payment_method_configuration?: string; /** * payment_method_data_params @@ -52740,6 +56178,8 @@ export interface operations { /** @enum {string} */ allow_redisplay?: "always" | "limited" | "unspecified"; /** param */ + alma?: Record; + /** param */ amazon_pay?: Record; /** param */ au_becs_debit?: { @@ -52799,6 +56239,8 @@ export interface operations { /** param */ interac_present?: Record; /** param */ + kakao_pay?: Record; + /** param */ klarna?: { /** date_of_birth */ dob?: { @@ -52810,6 +56252,8 @@ export interface operations { /** param */ konbini?: Record; /** param */ + kr_card?: Record; + /** param */ link?: Record; metadata?: { [key: string]: string; @@ -52819,6 +56263,11 @@ export interface operations { /** param */ multibanco?: Record; /** param */ + naver_pay?: { + /** @enum {string} */ + funding?: "card" | "points"; + }; + /** param */ oxxo?: Record; /** param */ p24?: { @@ -52826,6 +56275,8 @@ export interface operations { bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ + payco?: Record; + /** param */ paynow?: Record; /** param */ paypal?: Record; @@ -52840,6 +56291,8 @@ export interface operations { /** param */ revolut_pay?: Record; /** param */ + samsung_pay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -52853,7 +56306,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -52918,7 +56371,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; /** setup_intent_payment_method_options_param */ @@ -52982,7 +56435,7 @@ export interface operations { verification_method?: "automatic" | "instant" | "microdeposits"; }; }; - /** @description The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this array, it defaults to ["card"]. */ + /** @description The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ payment_method_types?: string[]; }; }; @@ -53121,6 +56574,8 @@ export interface operations { /** @enum {string} */ allow_redisplay?: "always" | "limited" | "unspecified"; /** param */ + alma?: Record; + /** param */ amazon_pay?: Record; /** param */ au_becs_debit?: { @@ -53180,6 +56635,8 @@ export interface operations { /** param */ interac_present?: Record; /** param */ + kakao_pay?: Record; + /** param */ klarna?: { /** date_of_birth */ dob?: { @@ -53191,6 +56648,8 @@ export interface operations { /** param */ konbini?: Record; /** param */ + kr_card?: Record; + /** param */ link?: Record; metadata?: { [key: string]: string; @@ -53200,6 +56659,11 @@ export interface operations { /** param */ multibanco?: Record; /** param */ + naver_pay?: { + /** @enum {string} */ + funding?: "card" | "points"; + }; + /** param */ oxxo?: Record; /** param */ p24?: { @@ -53207,6 +56671,8 @@ export interface operations { bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ + payco?: Record; + /** param */ paynow?: Record; /** param */ paypal?: Record; @@ -53221,6 +56687,8 @@ export interface operations { /** param */ revolut_pay?: Record; /** param */ + samsung_pay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -53234,7 +56702,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -53299,7 +56767,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; /** setup_intent_payment_method_options_param */ @@ -55628,7 +59096,7 @@ export interface operations { description?: string; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; @@ -55659,7 +59127,7 @@ export interface operations { verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "p24" | "payco" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; @@ -55970,7 +59438,7 @@ export interface operations { off_session?: boolean; /** @description The account on behalf of which to charge, for each of the subscription's invoices. */ on_behalf_of?: string | ""; - /** @description If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment). */ + /** @description If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment). */ pause_collection?: { /** @enum {string} */ behavior: "keep_as_draft" | "mark_uncollectible" | "void"; @@ -56017,7 +59485,7 @@ export interface operations { description?: string; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; @@ -56048,7 +59516,7 @@ export interface operations { verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "p24" | "payco" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; @@ -56137,7 +59605,7 @@ export interface operations { }; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`. */ + /** @description Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `false`. */ invoice_now?: boolean; /** @description Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to `false`. */ prorate?: boolean; @@ -56213,7 +59681,7 @@ export interface operations { content: { "application/x-www-form-urlencoded": { /** - * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). Setting the value to `unchanged` advances the subscription's billing cycle anchor to the period that surrounds the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). + * @description The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). * @enum {string} */ billing_cycle_anchor?: "now" | "unchanged"; @@ -56286,7 +59754,7 @@ export interface operations { ip_address?: string; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; /** @enum {string} */ @@ -56569,6 +60037,11 @@ export interface operations { /** @enum {string} */ type: "standard"; }; + /** simplified */ + by?: { + /** @enum {string} */ + type: "simplified"; + }; /** canada */ ca?: { /** province_standard */ @@ -56593,6 +60066,11 @@ export interface operations { /** @enum {string} */ type: "simplified"; }; + /** simplified */ + cr?: { + /** @enum {string} */ + type: "simplified"; + }; /** europe */ cy?: { /** standard */ @@ -56633,6 +60111,11 @@ export interface operations { /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; }; + /** simplified */ + ec?: { + /** @enum {string} */ + type: "simplified"; + }; /** europe */ ee?: { /** standard */ @@ -56798,6 +60281,16 @@ export interface operations { /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; }; + /** simplified */ + ma?: { + /** @enum {string} */ + type: "simplified"; + }; + /** simplified */ + md?: { + /** @enum {string} */ + type: "simplified"; + }; /** europe */ mt?: { /** standard */ @@ -56878,6 +60371,16 @@ export interface operations { /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; }; + /** default */ + rs?: { + /** @enum {string} */ + type: "standard"; + }; + /** simplified */ + ru?: { + /** @enum {string} */ + type: "simplified"; + }; /** simplified */ sa?: { /** @enum {string} */ @@ -56928,6 +60431,11 @@ export interface operations { /** @enum {string} */ type: "simplified"; }; + /** simplified */ + tz?: { + /** @enum {string} */ + type: "simplified"; + }; /** united_states */ us?: { /** local_amusement_tax */ @@ -56948,7 +60456,12 @@ export interface operations { }[]; }; /** @enum {string} */ - type: "local_amusement_tax" | "local_lease_tax" | "state_communications_tax" | "state_sales_tax"; + type: "local_amusement_tax" | "local_lease_tax" | "state_communications_tax" | "state_retail_delivery_fee" | "state_sales_tax"; + }; + /** simplified */ + uz?: { + /** @enum {string} */ + type: "simplified"; }; /** simplified */ vn?: { @@ -57556,10 +61069,10 @@ export interface operations { type: "account" | "application" | "customer" | "self"; }; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; /** @description Value of the tax ID. */ value: string; }; @@ -57759,7 +61272,7 @@ export interface operations { * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string} */ - tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; + tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "retail_delivery_fee" | "rst" | "sales_tax" | "service_tax" | "vat"; }; }; }; @@ -57856,7 +61369,7 @@ export interface operations { * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string} */ - tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; + tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "retail_delivery_fee" | "rst" | "sales_tax" | "service_tax" | "vat"; }; }; }; @@ -58045,6 +61558,12 @@ export interface operations { smart_tip_threshold?: number; }; /** currency_specific_config */ + pln?: { + fixed_amounts?: number[]; + percentages?: number[]; + smart_tip_threshold?: number; + }; + /** currency_specific_config */ sek?: { fixed_amounts?: number[]; percentages?: number[]; @@ -58234,6 +61753,12 @@ export interface operations { smart_tip_threshold?: number; }; /** currency_specific_config */ + pln?: { + fixed_amounts?: number[]; + percentages?: number[]; + smart_tip_threshold?: number; + }; + /** currency_specific_config */ sek?: { fixed_amounts?: number[]; percentages?: number[]; @@ -58877,6 +62402,8 @@ export interface operations { * @description Configuration overrides */ process_config?: { + /** @enum {string} */ + allow_redisplay?: "always" | "limited" | "unspecified"; enable_customer_cancellation?: boolean; skip_tipping?: boolean; /** tipping_config */ @@ -58920,8 +62447,11 @@ export interface operations { requestBody: { content: { "application/x-www-form-urlencoded": { - /** @description Customer Consent Collected */ - customer_consent_collected?: boolean; + /** + * @description This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. + * @enum {string} + */ + allow_redisplay: "always" | "limited" | "unspecified"; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @@ -59107,6 +62637,8 @@ export interface operations { /** @enum {string} */ allow_redisplay?: "always" | "limited" | "unspecified"; /** param */ + alma?: Record; + /** param */ amazon_pay?: Record; /** param */ au_becs_debit?: { @@ -59166,6 +62698,8 @@ export interface operations { /** param */ interac_present?: Record; /** param */ + kakao_pay?: Record; + /** param */ klarna?: { /** date_of_birth */ dob?: { @@ -59177,6 +62711,8 @@ export interface operations { /** param */ konbini?: Record; /** param */ + kr_card?: Record; + /** param */ link?: Record; metadata?: { [key: string]: string; @@ -59186,6 +62722,11 @@ export interface operations { /** param */ multibanco?: Record; /** param */ + naver_pay?: { + /** @enum {string} */ + funding?: "card" | "points"; + }; + /** param */ oxxo?: Record; /** param */ p24?: { @@ -59193,6 +62734,8 @@ export interface operations { bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ + payco?: Record; + /** param */ paynow?: Record; /** param */ paypal?: Record; @@ -59207,6 +62750,8 @@ export interface operations { /** param */ revolut_pay?: Record; /** param */ + samsung_pay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -59220,7 +62765,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -59341,7 +62886,7 @@ export interface operations { content: { "application/x-www-form-urlencoded": { /** @description The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - amount: number; + amount?: number; /** * amount_details_specs * @description Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). @@ -59416,6 +62961,10 @@ export interface operations { }; /** @description If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. */ is_amount_controllable?: boolean; + /** @description The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + merchant_amount?: number; + /** @description The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + merchant_currency?: string; /** * merchant_data_specs * @description Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened. @@ -59750,6 +63299,46 @@ export interface operations { }; }; }; + PostTestHelpersIssuingAuthorizationsAuthorizationFraudChallengesRespond: { + parameters: { + query?: never; + header?: never; + path: { + authorization: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Whether to simulate the user confirming that the transaction was legitimate (true) or telling Stripe that it was fraudulent (false). */ + confirmed: boolean; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issuing.authorization"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostTestHelpersIssuingAuthorizationsAuthorizationIncrement: { parameters: { query?: never; @@ -59984,6 +63573,44 @@ export interface operations { }; }; }; + PostTestHelpersIssuingCardsCardShippingSubmit: { + parameters: { + query?: never; + header?: never; + path: { + card: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issuing.card"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate: { parameters: { query?: never; @@ -60804,7 +64431,7 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * failure_details_params + * failure_details_param * @description Details about a failed InboundTransfer. */ failure_details?: { @@ -64283,13 +67910,13 @@ export interface operations { * @description Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version. * @enum {string} */ - api_version?: "2011-01-01" | "2011-06-21" | "2011-06-28" | "2011-08-01" | "2011-09-15" | "2011-11-17" | "2012-02-23" | "2012-03-25" | "2012-06-18" | "2012-06-28" | "2012-07-09" | "2012-09-24" | "2012-10-26" | "2012-11-07" | "2013-02-11" | "2013-02-13" | "2013-07-05" | "2013-08-12" | "2013-08-13" | "2013-10-29" | "2013-12-03" | "2014-01-31" | "2014-03-13" | "2014-03-28" | "2014-05-19" | "2014-06-13" | "2014-06-17" | "2014-07-22" | "2014-07-26" | "2014-08-04" | "2014-08-20" | "2014-09-08" | "2014-10-07" | "2014-11-05" | "2014-11-20" | "2014-12-08" | "2014-12-17" | "2014-12-22" | "2015-01-11" | "2015-01-26" | "2015-02-10" | "2015-02-16" | "2015-02-18" | "2015-03-24" | "2015-04-07" | "2015-06-15" | "2015-07-07" | "2015-07-13" | "2015-07-28" | "2015-08-07" | "2015-08-19" | "2015-09-03" | "2015-09-08" | "2015-09-23" | "2015-10-01" | "2015-10-12" | "2015-10-16" | "2016-02-03" | "2016-02-19" | "2016-02-22" | "2016-02-23" | "2016-02-29" | "2016-03-07" | "2016-06-15" | "2016-07-06" | "2016-10-19" | "2017-01-27" | "2017-02-14" | "2017-04-06" | "2017-05-25" | "2017-06-05" | "2017-08-15" | "2017-12-14" | "2018-01-23" | "2018-02-05" | "2018-02-06" | "2018-02-28" | "2018-05-21" | "2018-07-27" | "2018-08-23" | "2018-09-06" | "2018-09-24" | "2018-10-31" | "2018-11-08" | "2019-02-11" | "2019-02-19" | "2019-03-14" | "2019-05-16" | "2019-08-14" | "2019-09-09" | "2019-10-08" | "2019-10-17" | "2019-11-05" | "2019-12-03" | "2020-03-02" | "2020-08-27" | "2022-08-01" | "2022-11-15" | "2023-08-16" | "2023-10-16" | "2024-04-10" | "2024-06-20"; + api_version?: "2011-01-01" | "2011-06-21" | "2011-06-28" | "2011-08-01" | "2011-09-15" | "2011-11-17" | "2012-02-23" | "2012-03-25" | "2012-06-18" | "2012-06-28" | "2012-07-09" | "2012-09-24" | "2012-10-26" | "2012-11-07" | "2013-02-11" | "2013-02-13" | "2013-07-05" | "2013-08-12" | "2013-08-13" | "2013-10-29" | "2013-12-03" | "2014-01-31" | "2014-03-13" | "2014-03-28" | "2014-05-19" | "2014-06-13" | "2014-06-17" | "2014-07-22" | "2014-07-26" | "2014-08-04" | "2014-08-20" | "2014-09-08" | "2014-10-07" | "2014-11-05" | "2014-11-20" | "2014-12-08" | "2014-12-17" | "2014-12-22" | "2015-01-11" | "2015-01-26" | "2015-02-10" | "2015-02-16" | "2015-02-18" | "2015-03-24" | "2015-04-07" | "2015-06-15" | "2015-07-07" | "2015-07-13" | "2015-07-28" | "2015-08-07" | "2015-08-19" | "2015-09-03" | "2015-09-08" | "2015-09-23" | "2015-10-01" | "2015-10-12" | "2015-10-16" | "2016-02-03" | "2016-02-19" | "2016-02-22" | "2016-02-23" | "2016-02-29" | "2016-03-07" | "2016-06-15" | "2016-07-06" | "2016-10-19" | "2017-01-27" | "2017-02-14" | "2017-04-06" | "2017-05-25" | "2017-06-05" | "2017-08-15" | "2017-12-14" | "2018-01-23" | "2018-02-05" | "2018-02-06" | "2018-02-28" | "2018-05-21" | "2018-07-27" | "2018-08-23" | "2018-09-06" | "2018-09-24" | "2018-10-31" | "2018-11-08" | "2019-02-11" | "2019-02-19" | "2019-03-14" | "2019-05-16" | "2019-08-14" | "2019-09-09" | "2019-10-08" | "2019-10-17" | "2019-11-05" | "2019-12-03" | "2020-03-02" | "2020-08-27" | "2022-08-01" | "2022-11-15" | "2023-08-16" | "2023-10-16" | "2024-04-10" | "2024-06-20" | "2024-09-30.acacia" | "2024-10-28.acacia"; /** @description Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`. */ connect?: boolean; /** @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.alert.triggered" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "climate.order.canceled" | "climate.order.created" | "climate.order.delayed" | "climate.order.delivered" | "climate.order.product_substituted" | "climate.product.created" | "climate.product.pricing_updated" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "entitlements.active_entitlement_summary.updated" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "financial_connections.account.refreshed_ownership" | "financial_connections.account.refreshed_transactions" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.overdue" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoice.will_be_due" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.funds_rescinded" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_personalization_design.activated" | "issuing_personalization_design.deactivated" | "issuing_personalization_design.rejected" | "issuing_personalization_design.updated" | "issuing_token.created" | "issuing_token.updated" | "issuing_transaction.created" | "issuing_transaction.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_payment.tracking_details_updated" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.outbound_transfer.tracking_details_updated" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; + 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.alert.triggered" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "climate.order.canceled" | "climate.order.created" | "climate.order.delayed" | "climate.order.delivered" | "climate.order.product_substituted" | "climate.product.created" | "climate.product.pricing_updated" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "entitlements.active_entitlement_summary.updated" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "financial_connections.account.refreshed_ownership" | "financial_connections.account.refreshed_transactions" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.overdue" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoice.will_be_due" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.funds_rescinded" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_personalization_design.activated" | "issuing_personalization_design.deactivated" | "issuing_personalization_design.rejected" | "issuing_personalization_design.updated" | "issuing_token.created" | "issuing_token.updated" | "issuing_transaction.created" | "issuing_transaction.purchase_details_receipt_updated" | "issuing_transaction.updated" | "mandate.updated" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "refund.created" | "refund.failed" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_payment.tracking_details_updated" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.outbound_transfer.tracking_details_updated" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; /** @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`. */ @@ -64377,7 +68004,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.alert.triggered" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "climate.order.canceled" | "climate.order.created" | "climate.order.delayed" | "climate.order.delivered" | "climate.order.product_substituted" | "climate.product.created" | "climate.product.pricing_updated" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "entitlements.active_entitlement_summary.updated" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "financial_connections.account.refreshed_ownership" | "financial_connections.account.refreshed_transactions" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.overdue" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoice.will_be_due" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.funds_rescinded" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_personalization_design.activated" | "issuing_personalization_design.deactivated" | "issuing_personalization_design.rejected" | "issuing_personalization_design.updated" | "issuing_token.created" | "issuing_token.updated" | "issuing_transaction.created" | "issuing_transaction.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_payment.tracking_details_updated" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.outbound_transfer.tracking_details_updated" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; + 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.alert.triggered" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "climate.order.canceled" | "climate.order.created" | "climate.order.delayed" | "climate.order.delivered" | "climate.order.product_substituted" | "climate.product.created" | "climate.product.pricing_updated" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "entitlements.active_entitlement_summary.updated" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "financial_connections.account.refreshed_ownership" | "financial_connections.account.refreshed_transactions" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.overdue" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoice.will_be_due" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.funds_rescinded" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_personalization_design.activated" | "issuing_personalization_design.deactivated" | "issuing_personalization_design.rejected" | "issuing_personalization_design.updated" | "issuing_token.created" | "issuing_token.updated" | "issuing_transaction.created" | "issuing_transaction.purchase_details_receipt_updated" | "issuing_transaction.updated" | "mandate.updated" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "refund.created" | "refund.failed" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_payment.tracking_details_updated" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.outbound_transfer.tracking_details_updated" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; /** @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 870997aa0..d86320dd5 100644 --- a/packages/openapi-typescript/examples/stripe-api.yaml +++ b/packages/openapi-typescript/examples/stripe-api.yaml @@ -56,7 +56,7 @@ components: capabilities: $ref: '#/components/schemas/account_capabilities' charges_enabled: - description: Whether the account can create live charges. + description: Whether the account can process charges. type: boolean company: $ref: '#/components/schemas/legal_entity_company' @@ -139,6 +139,11 @@ components: - data future_requirements: $ref: '#/components/schemas/account_future_requirements' + groups: + anyOf: + - $ref: '#/components/schemas/account_group_membership' + description: The groups associated with the account. + nullable: true id: description: Unique identifier for the object. maxLength: 5000 @@ -162,7 +167,7 @@ components: - account type: string payouts_enabled: - description: Whether Stripe can send payouts to this account. + description: Whether the funds in this account can be paid out. type: boolean requirements: $ref: '#/components/schemas/account_requirements' @@ -195,6 +200,7 @@ components: - controller - external_accounts - future_requirements + - groups - individual - requirements - settings @@ -403,6 +409,15 @@ components: - inactive - pending type: string + alma_payments: + description: >- + The status of the Alma capability of the account, or whether the + account can directly process Alma payments. + enum: + - active + - inactive + - pending + type: string amazon_pay_payments: description: >- The status of the AmazonPay capability of the account, or whether @@ -592,6 +607,15 @@ components: - inactive - pending type: string + kakao_pay_payments: + description: >- + The status of the KakaoPay capability of the account, or whether the + account can directly process KakaoPay payments. + enum: + - active + - inactive + - pending + type: string klarna_payments: description: >- The status of the Klarna payments capability of the account, or @@ -610,6 +634,15 @@ components: - inactive - pending type: string + kr_card_payments: + description: >- + The status of the KrCard capability of the account, or whether the + account can directly process KrCard payments. + enum: + - active + - inactive + - pending + type: string legacy_payments: description: The status of the legacy payments capability of the account. enum: @@ -654,6 +687,15 @@ components: - inactive - pending type: string + naver_pay_payments: + description: >- + The status of the NaverPay capability of the account, or whether the + account can directly process NaverPay payments. + enum: + - active + - inactive + - pending + type: string oxxo_payments: description: >- The status of the OXXO payments capability of the account, or @@ -672,6 +714,15 @@ components: - inactive - pending type: string + payco_payments: + description: >- + The status of the Payco capability of the account, or whether the + account can directly process Payco payments. + enum: + - active + - inactive + - pending + type: string paynow_payments: description: >- The status of the paynow payments capability of the account, or @@ -699,6 +750,15 @@ components: - inactive - pending type: string + samsung_pay_payments: + description: >- + The status of the SamsungPay capability of the account, or whether + the account can directly process SamsungPay payments. + enum: + - active + - inactive + - pending + type: string sepa_bank_transfer_payments: description: >- The status of the SEPA customer_balance payments (EUR currency) @@ -1132,9 +1192,24 @@ components: type: array disabled_reason: description: >- - This is typed as a string for consistency with + This is typed as an enum for consistency with `requirements.disabled_reason`. - maxLength: 5000 + enum: + - action_required.requested_capabilities + - listed + - other + - platform_paused + - rejected.fraud + - rejected.incomplete_verification + - rejected.listed + - rejected.other + - rejected.platform_fraud + - rejected.platform_other + - rejected.platform_terms_of_service + - rejected.terms_of_service + - requirements.past_due + - requirements.pending_verification + - under_review nullable: true type: string errors: @@ -1185,6 +1260,22 @@ components: x-expandableFields: - alternatives - errors + account_group_membership: + description: '' + properties: + payments_pricing: + description: >- + The group the account is in to determine their payments pricing, and + null if the account is on customized pricing. [See the Platform + pricing tool + documentation](https://stripe.com/docs/connect/platform-pricing-tools) + for details. + maxLength: 5000 + nullable: true + type: string + title: AccountGroupMembership + type: object + x-expandableFields: [] account_invoices_settings: description: '' properties: @@ -1374,16 +1465,25 @@ components: type: array disabled_reason: description: >- - If the account is disabled, this string describes why. [Learn more + If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). - Can be `action_required.requested_capabilities`, - `requirements.past_due`, `requirements.pending_verification`, - `listed`, `platform_paused`, `rejected.fraud`, - `rejected.incomplete_verification`, `rejected.listed`, - `rejected.other`, `rejected.terms_of_service`, `under_review`, or - `other`. - maxLength: 5000 + enum: + - action_required.requested_capabilities + - listed + - other + - platform_paused + - rejected.fraud + - rejected.incomplete_verification + - rejected.listed + - rejected.other + - rejected.platform_fraud + - rejected.platform_other + - rejected.platform_terms_of_service + - rejected.terms_of_service + - requirements.past_due + - requirements.pending_verification + - under_review nullable: true type: string errors: @@ -3207,13 +3307,6 @@ components: - usage_threshold type: string x-stripeBypassValidation: true - filter: - anyOf: - - $ref: '#/components/schemas/thresholds_resource_alert_filter' - description: >- - Limits the scope of the alert to a specific - [customer](https://stripe.com/docs/api/customers). - nullable: true id: description: Unique identifier for the object. maxLength: 5000 @@ -3242,7 +3335,7 @@ components: description: Title of the alert. maxLength: 5000 type: string - usage_threshold_config: + usage_threshold: anyOf: - $ref: '#/components/schemas/thresholds_resource_usage_threshold_config' description: >- @@ -3258,9 +3351,268 @@ components: title: ThresholdsResourceAlert type: object x-expandableFields: - - filter - - usage_threshold_config + - usage_threshold x-resourceId: billing.alert + billing.credit_balance_summary: + description: >- + Indicates the billing credit balance for billing credits granted to a + customer. + properties: + balances: + description: >- + The billing credit balances. One entry per credit grant currency. If + a customer only has credit grants in a single currency, then this + will have a single balance entry. + items: + $ref: '#/components/schemas/credit_balance' + type: array + customer: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/customer' + - $ref: '#/components/schemas/deleted_customer' + description: The customer the balance is for. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/customer' + - $ref: '#/components/schemas/deleted_customer' + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - billing.credit_balance_summary + type: string + required: + - balances + - customer + - livemode + - object + title: CreditBalanceSummary + type: object + x-expandableFields: + - balances + - customer + x-resourceId: billing.credit_balance_summary + billing.credit_balance_transaction: + description: >- + A credit balance transaction is a resource representing a transaction + (either a credit or a debit) against an existing credit grant. + properties: + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + credit: + anyOf: + - $ref: >- + #/components/schemas/billing_credit_grants_resource_balance_credit + description: >- + Credit details for this credit balance transaction. Only present if + type is `credit`. + nullable: true + credit_grant: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/billing.credit_grant' + description: The credit grant associated with this credit balance transaction. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/billing.credit_grant' + debit: + anyOf: + - $ref: >- + #/components/schemas/billing_credit_grants_resource_balance_debit + description: >- + Debit details for this credit balance transaction. Only present if + type is `debit`. + nullable: true + effective_at: + description: The effective time of this credit balance transaction. + format: unix-time + type: integer + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - billing.credit_balance_transaction + type: string + test_clock: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/test_helpers.test_clock' + description: ID of the test clock this credit balance transaction belongs to. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/test_helpers.test_clock' + type: + description: The type of credit balance transaction (credit or debit). + enum: + - credit + - debit + nullable: true + type: string + required: + - created + - credit_grant + - effective_at + - id + - livemode + - object + title: CreditBalanceTransaction + type: object + x-expandableFields: + - credit + - credit_grant + - debit + - test_clock + x-resourceId: billing.credit_balance_transaction + billing.credit_grant: + description: >- + A credit grant is an API resource that documents the allocation of some + billing credits to a customer. + + + Related guide: [Billing + credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits) + properties: + amount: + $ref: '#/components/schemas/billing_credit_grants_resource_amount' + applicability_config: + $ref: >- + #/components/schemas/billing_credit_grants_resource_applicability_config + category: + description: >- + The category of this credit grant. This is for tracking purposes and + isn't displayed to the customer. + enum: + - paid + - promotional + type: string + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + customer: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/customer' + - $ref: '#/components/schemas/deleted_customer' + description: ID of the customer receiving the billing credits. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/customer' + - $ref: '#/components/schemas/deleted_customer' + effective_at: + description: >- + The time when the billing credits become effective—when they're + eligible for use. + format: unix-time + nullable: true + type: integer + expires_at: + description: >- + The time when the billing credits expire. If not present, the + billing credits don't expire. + format: unix-time + nullable: true + type: integer + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + metadata: + additionalProperties: + maxLength: 500 + type: string + description: >- + Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + you can attach to an object. This can be useful for storing + additional information about the object in a structured format. + type: object + name: + description: A descriptive name shown in dashboard. + maxLength: 5000 + nullable: true + type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - billing.credit_grant + type: string + test_clock: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/test_helpers.test_clock' + description: ID of the test clock this credit grant belongs to. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/test_helpers.test_clock' + updated: + description: >- + Time at which the object was last updated. Measured in seconds since + the Unix epoch. + format: unix-time + type: integer + voided_at: + description: >- + The time when this credit grant was voided. If not present, the + credit grant hasn't been voided. + format: unix-time + nullable: true + type: integer + required: + - amount + - applicability_config + - category + - created + - customer + - id + - livemode + - metadata + - object + - updated + title: CreditGrant + type: object + x-expandableFields: + - amount + - applicability_config + - customer + - test_clock + x-resourceId: billing.credit_grant billing.meter: description: >- A billing meter is a resource that allows you to track usage of a @@ -3268,6 +3620,10 @@ components: the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make. + + + Related guide: [Usage based + billing](https://docs.stripe.com/billing/subscriptions/usage-based) properties: created: description: >- @@ -3551,6 +3907,144 @@ components: type: object x-expandableFields: - advancing + billing_credit_grants_resource_amount: + description: '' + properties: + monetary: + anyOf: + - $ref: >- + #/components/schemas/billing_credit_grants_resource_monetary_amount + description: The monetary amount. + nullable: true + type: + description: >- + The type of this amount. We currently only support `monetary` + billing credits. + enum: + - monetary + type: string + required: + - type + title: BillingCreditGrantsResourceAmount + type: object + x-expandableFields: + - monetary + billing_credit_grants_resource_applicability_config: + description: '' + properties: + scope: + $ref: '#/components/schemas/billing_credit_grants_resource_scope' + required: + - scope + title: BillingCreditGrantsResourceApplicabilityConfig + type: object + x-expandableFields: + - scope + billing_credit_grants_resource_balance_credit: + description: '' + properties: + amount: + $ref: '#/components/schemas/billing_credit_grants_resource_amount' + type: + description: The type of credit transaction. + enum: + - credits_granted + type: string + required: + - amount + - type + title: BillingCreditGrantsResourceBalanceCredit + type: object + x-expandableFields: + - amount + billing_credit_grants_resource_balance_credits_applied: + description: '' + properties: + invoice: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/invoice' + description: The invoice to which the billing credits were applied. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/invoice' + invoice_line_item: + description: The invoice line item to which the billing credits were applied. + maxLength: 5000 + type: string + required: + - invoice + - invoice_line_item + title: BillingCreditGrantsResourceBalanceCreditsApplied + type: object + x-expandableFields: + - invoice + billing_credit_grants_resource_balance_debit: + description: '' + properties: + amount: + $ref: '#/components/schemas/billing_credit_grants_resource_amount' + credits_applied: + anyOf: + - $ref: >- + #/components/schemas/billing_credit_grants_resource_balance_credits_applied + description: >- + Details of how the billing credits were applied to an invoice. Only + present if `type` is `credits_applied`. + nullable: true + type: + description: The type of debit transaction. + enum: + - credits_applied + - credits_expired + - credits_voided + type: string + required: + - amount + - type + title: BillingCreditGrantsResourceBalanceDebit + type: object + x-expandableFields: + - amount + - credits_applied + billing_credit_grants_resource_monetary_amount: + description: '' + properties: + currency: + description: >- + Three-letter [ISO currency + code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a [supported + currency](https://stripe.com/docs/currencies). + maxLength: 5000 + type: string + value: + description: A positive integer representing the amount. + type: integer + required: + - currency + - value + title: BillingCreditGrantsResourceMonetaryAmount + type: object + x-expandableFields: [] + billing_credit_grants_resource_scope: + description: '' + properties: + price_type: + description: >- + The price type for which credit grants can apply. We currently only + support the `metered` price type. This refers to prices that have a + [Billing Meter](https://docs.stripe.com/api/billing/meter) attached + to them. + enum: + - metered + type: string + required: + - price_type + title: BillingCreditGrantsResourceScope + type: object + x-expandableFields: [] billing_details: description: '' properties: @@ -4001,9 +4495,7 @@ components: requirements: $ref: '#/components/schemas/account_capability_requirements' status: - description: >- - The status of the capability. Can be `active`, `inactive`, - `pending`, or `unrequested`. + description: The status of the capability. enum: - active - disabled @@ -4956,6 +5448,14 @@ components: Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart) properties: + adaptive_pricing: + anyOf: + - $ref: >- + #/components/schemas/payment_pages_checkout_session_adaptive_pricing + description: >- + Settings for price localization with [Adaptive + Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). + nullable: true after_expiration: anyOf: - $ref: >- @@ -5421,6 +5921,7 @@ components: - book - donate - pay + - subscribe nullable: true type: string subscription: @@ -5487,6 +5988,7 @@ components: title: Session type: object x-expandableFields: + - adaptive_pricing - after_expiration - automatic_tax - consent @@ -5779,6 +6281,9 @@ components: checkout_bacs_debit_payment_method_options: description: '' properties: + mandate_options: + $ref: >- + #/components/schemas/checkout_payment_method_options_mandate_options_bacs_debit setup_future_usage: description: >- Indicates that you intend to make future payments with this @@ -5810,7 +6315,8 @@ components: type: string title: CheckoutBacsDebitPaymentMethodOptions type: object - x-expandableFields: [] + x-expandableFields: + - mandate_options checkout_bancontact_payment_method_options: description: '' properties: @@ -5902,6 +6408,40 @@ components: properties: installments: $ref: '#/components/schemas/checkout_card_installments_options' + request_extended_authorization: + description: >- + Request ability to [capture beyond the standard authorization + validity window](/payments/extended-authorization) for this + CheckoutSession. + enum: + - if_available + - never + type: string + request_incremental_authorization: + description: >- + Request ability to [increment the + authorization](/payments/incremental-authorization) for this + CheckoutSession. + enum: + - if_available + - never + type: string + request_multicapture: + description: >- + Request ability to make [multiple captures](/payments/multicapture) + for this CheckoutSession. + enum: + - if_available + - never + type: string + request_overcapture: + description: >- + Request ability to [overcapture](/payments/overcapture) for this + CheckoutSession. + enum: + - if_available + - never + type: string request_three_d_secure: description: >- We strongly recommend that you rely on our SCA Engine to @@ -6264,6 +6804,47 @@ components: title: CheckoutIdealPaymentMethodOptions type: object x-expandableFields: [] + checkout_kakao_pay_payment_method_options: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a + Customer after the transaction completes. + + + If the payment method is `card_present` and isn't a digital wallet, + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. + + + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). + enum: + - none + - off_session + type: string + title: CheckoutKakaoPayPaymentMethodOptions + type: object + x-expandableFields: [] checkout_klarna_payment_method_options: description: '' properties: @@ -6340,6 +6921,47 @@ components: title: CheckoutKonbiniPaymentMethodOptions type: object x-expandableFields: [] + checkout_kr_card_payment_method_options: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a + Customer after the transaction completes. + + + If the payment method is `card_present` and isn't a digital wallet, + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. + + + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). + enum: + - none + - off_session + type: string + title: CheckoutKrCardPaymentMethodOptions + type: object + x-expandableFields: [] checkout_link_payment_method_options: description: '' properties: @@ -6440,6 +7062,19 @@ components: title: CheckoutMultibancoPaymentMethodOptions type: object x-expandableFields: [] + checkout_naver_pay_payment_method_options: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + title: CheckoutNaverPayPaymentMethodOptions + type: object + x-expandableFields: [] checkout_oxxo_payment_method_options: description: '' properties: @@ -6515,6 +7150,31 @@ components: title: CheckoutP24PaymentMethodOptions type: object x-expandableFields: [] + checkout_payco_payment_method_options: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + title: CheckoutPaycoPaymentMethodOptions + type: object + x-expandableFields: [] + checkout_payment_method_options_mandate_options_bacs_debit: + description: '' + properties: {} + title: checkout_payment_method_options_mandate_options_bacs_debit + type: object + x-expandableFields: [] + checkout_payment_method_options_mandate_options_sepa_debit: + description: '' + properties: {} + title: checkout_payment_method_options_mandate_options_sepa_debit + type: object + x-expandableFields: [] checkout_paynow_payment_method_options: description: '' properties: @@ -6649,9 +7309,25 @@ components: title: CheckoutRevolutPayPaymentMethodOptions type: object x-expandableFields: [] + checkout_samsung_pay_payment_method_options: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + title: CheckoutSamsungPayPaymentMethodOptions + type: object + x-expandableFields: [] checkout_sepa_debit_payment_method_options: description: '' properties: + mandate_options: + $ref: >- + #/components/schemas/checkout_payment_method_options_mandate_options_sepa_debit setup_future_usage: description: >- Indicates that you intend to make future payments with this @@ -6683,7 +7359,8 @@ components: type: string title: CheckoutSepaDebitPaymentMethodOptions type: object - x-expandableFields: [] + x-expandableFields: + - mandate_options checkout_session_payment_method_options: description: '' properties: @@ -6723,20 +7400,28 @@ components: $ref: '#/components/schemas/checkout_grab_pay_payment_method_options' ideal: $ref: '#/components/schemas/checkout_ideal_payment_method_options' + kakao_pay: + $ref: '#/components/schemas/checkout_kakao_pay_payment_method_options' klarna: $ref: '#/components/schemas/checkout_klarna_payment_method_options' konbini: $ref: '#/components/schemas/checkout_konbini_payment_method_options' + kr_card: + $ref: '#/components/schemas/checkout_kr_card_payment_method_options' link: $ref: '#/components/schemas/checkout_link_payment_method_options' mobilepay: $ref: '#/components/schemas/checkout_mobilepay_payment_method_options' multibanco: $ref: '#/components/schemas/checkout_multibanco_payment_method_options' + naver_pay: + $ref: '#/components/schemas/checkout_naver_pay_payment_method_options' oxxo: $ref: '#/components/schemas/checkout_oxxo_payment_method_options' p24: $ref: '#/components/schemas/checkout_p24_payment_method_options' + payco: + $ref: '#/components/schemas/checkout_payco_payment_method_options' paynow: $ref: '#/components/schemas/checkout_paynow_payment_method_options' paypal: @@ -6745,6 +7430,8 @@ components: $ref: '#/components/schemas/checkout_pix_payment_method_options' revolut_pay: $ref: '#/components/schemas/checkout_revolut_pay_payment_method_options' + samsung_pay: + $ref: '#/components/schemas/checkout_samsung_pay_payment_method_options' sepa_debit: $ref: '#/components/schemas/checkout_sepa_debit_payment_method_options' sofort: @@ -6773,17 +7460,22 @@ components: - giropay - grabpay - ideal + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -7156,6 +7848,7 @@ components: - direct_air_capture - enhanced_weathering type: string + x-stripeBypassValidation: true required: - id - info_url @@ -7503,6 +8196,8 @@ components: - limited - unspecified type: string + alma: + $ref: '#/components/schemas/payment_method_alma' amazon_pay: $ref: '#/components/schemas/payment_method_amazon_pay' au_becs_debit: @@ -7550,20 +8245,28 @@ components: $ref: '#/components/schemas/payment_method_ideal' interac_present: $ref: '#/components/schemas/payment_method_interac_present' + kakao_pay: + $ref: '#/components/schemas/payment_method_kakao_pay' klarna: $ref: '#/components/schemas/payment_method_klarna' konbini: $ref: '#/components/schemas/payment_method_konbini' + kr_card: + $ref: '#/components/schemas/payment_method_kr_card' link: $ref: '#/components/schemas/payment_method_link' mobilepay: $ref: '#/components/schemas/payment_method_mobilepay' multibanco: $ref: '#/components/schemas/payment_method_multibanco' + naver_pay: + $ref: '#/components/schemas/payment_method_naver_pay' oxxo: $ref: '#/components/schemas/payment_method_oxxo' p24: $ref: '#/components/schemas/payment_method_p24' + payco: + $ref: '#/components/schemas/payment_method_payco' paynow: $ref: '#/components/schemas/payment_method_paynow' paypal: @@ -7574,6 +8277,8 @@ components: $ref: '#/components/schemas/payment_method_promptpay' revolut_pay: $ref: '#/components/schemas/payment_method_revolut_pay' + samsung_pay: + $ref: '#/components/schemas/payment_method_samsung_pay' sepa_debit: $ref: '#/components/schemas/payment_method_sepa_debit' sofort: @@ -7592,6 +8297,7 @@ components: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -7608,18 +8314,23 @@ components: - grabpay - ideal - interac_present + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -7645,6 +8356,7 @@ components: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -7663,18 +8375,23 @@ components: - grabpay - ideal - interac_present + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -7794,15 +8511,26 @@ components: connect_embedded_account_features_claim: description: '' properties: + disable_stripe_user_authentication: + description: >- + Disables Stripe user authentication for this embedded component. + This feature can only be false for accounts where you’re responsible + for collecting updated information when requirements are due or + change, like custom accounts. The default value for this feature is + `false` when `external_account_collection` is enabled and `true` + otherwise. + type: boolean external_account_collection: description: >- Whether to allow platforms to control bank account collection for - their connected accounts. This feature can only be false for custom - accounts (or accounts where the platform is compliance owner). + their connected accounts. This feature can only be false for + accounts where you’re responsible for collecting updated information + when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance - requirements. + requirements. The default value for this feature is `true`. type: boolean required: + - disable_stripe_user_authentication - external_account_collection title: ConnectEmbeddedAccountFeaturesClaim type: object @@ -7941,6 +8669,15 @@ components: connect_embedded_payouts_features: description: '' properties: + disable_stripe_user_authentication: + description: >- + Disables Stripe user authentication for this embedded component. + This feature can only be false for accounts where you’re responsible + for collecting updated information when requirements are due or + change, like custom accounts. The default value for this feature is + `false` when `external_account_collection` is enabled and `true` + otherwise. + type: boolean edit_payout_schedule: description: >- Whether to allow payout schedule to be changed. Default `true` when @@ -7949,10 +8686,11 @@ components: external_account_collection: description: >- Whether to allow platforms to control bank account collection for - their connected accounts. This feature can only be false for custom - accounts (or accounts where the platform is compliance owner). + their connected accounts. This feature can only be false for + accounts where you’re responsible for collecting updated information + when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance - requirements. + requirements. The default value for this feature is `true`. type: boolean instant_payouts: description: >- @@ -7965,6 +8703,7 @@ components: Stripe owns Loss Liability, default `false` otherwise. type: boolean required: + - disable_stripe_user_authentication - edit_payout_schedule - external_account_collection - instant_payouts @@ -8255,6 +8994,21 @@ components: title: CouponCurrencyOption type: object x-expandableFields: [] + credit_balance: + description: '' + properties: + available_balance: + $ref: '#/components/schemas/billing_credit_grants_resource_amount' + ledger_balance: + $ref: '#/components/schemas/billing_credit_grants_resource_amount' + required: + - available_balance + - ledger_balance + title: CreditBalance + type: object + x-expandableFields: + - available_balance + - ledger_balance credit_note: description: >- Issue a credit note to adjust an invoice's amount after the invoice is @@ -8411,6 +9165,13 @@ components: description: The link to download the PDF of the credit note. maxLength: 5000 type: string + pretax_credit_amounts: + description: >- + The pretax credit amounts (ex: discount, credit grants, etc) for all + line items. + items: + $ref: '#/components/schemas/credit_notes_pretax_credit_amount' + type: array reason: description: >- Reason for issuing this credit note, one of `duplicate`, @@ -8522,6 +9283,7 @@ components: - discount_amounts - invoice - lines + - pretax_credit_amounts - refund - shipping_cost - tax_amounts @@ -8577,6 +9339,13 @@ components: enum: - credit_note_line_item type: string + pretax_credit_amounts: + description: >- + The pretax credit amounts (ex: discount, credit grants, etc) for + this line item. + items: + $ref: '#/components/schemas/credit_notes_pretax_credit_amount' + type: array quantity: description: The number of units of product being credited. nullable: true @@ -8634,6 +9403,7 @@ components: type: object x-expandableFields: - discount_amounts + - pretax_credit_amounts - tax_amounts - tax_rates x-resourceId: credit_note_line_item @@ -8693,6 +9463,50 @@ components: type: object x-expandableFields: - tax_rate + credit_notes_pretax_credit_amount: + description: '' + properties: + amount: + description: >- + The amount, in cents (or local equivalent), of the pretax credit + amount. + type: integer + credit_balance_transaction: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/billing.credit_balance_transaction' + description: >- + The credit balance transaction that was applied to get this pretax + credit amount. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/billing.credit_balance_transaction' + discount: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/discount' + - $ref: '#/components/schemas/deleted_discount' + description: The discount that was applied to get this pretax credit amount. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/discount' + - $ref: '#/components/schemas/deleted_discount' + type: + description: Type of the pretax credit amount referenced. + enum: + - credit_balance_transaction + - discount + type: string + required: + - amount + - type + title: CreditNotesPretaxCreditAmount + type: object + x-expandableFields: + - credit_balance_transaction + - discount currency_option: description: '' properties: @@ -8767,12 +9581,12 @@ components: x-expandableFields: [] 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. - + This object represents a customer of your business. Use it to [create + recurring charges](https://stripe.com/docs/invoicing/customer), [save + payment](https://stripe.com/docs/payments/save-during-payment) and + contact information, - Related guide: [Save a card during - payment](https://stripe.com/docs/payments/save-during-payment) + and track payments that belong to the same customer. properties: address: anyOf: @@ -10963,6 +11777,14 @@ components: lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). type: string + enhanced_eligibility_types: + description: List of eligibility types that are included in `enhanced_evidence`. + items: + enum: + - visa_compelling_evidence_3 + type: string + x-stripeBypassValidation: true + type: array evidence: $ref: '#/components/schemas/dispute_evidence' evidence_details: @@ -11042,6 +11864,7 @@ components: - charge - created - currency + - enhanced_eligibility_types - evidence - evidence_details - id @@ -11061,6 +11884,81 @@ components: - payment_intent - payment_method_details x-resourceId: dispute + dispute_enhanced_eligibility: + description: '' + properties: + visa_compelling_evidence_3: + $ref: >- + #/components/schemas/dispute_enhanced_eligibility_visa_compelling_evidence3 + title: DisputeEnhancedEligibility + type: object + x-expandableFields: + - visa_compelling_evidence_3 + dispute_enhanced_eligibility_visa_compelling_evidence3: + description: '' + properties: + required_actions: + description: >- + List of actions required to qualify dispute for Visa Compelling + Evidence 3.0 evidence submission. + items: + enum: + - missing_customer_identifiers + - missing_disputed_transaction_description + - missing_merchandise_or_services + - missing_prior_undisputed_transaction_description + - missing_prior_undisputed_transactions + type: string + type: array + status: + description: Visa Compelling Evidence 3.0 eligibility status. + enum: + - not_qualified + - qualified + - requires_action + type: string + required: + - required_actions + - status + title: DisputeEnhancedEligibilityVisaCompellingEvidence3 + type: object + x-expandableFields: [] + dispute_enhanced_evidence: + description: '' + properties: + visa_compelling_evidence_3: + $ref: >- + #/components/schemas/dispute_enhanced_evidence_visa_compelling_evidence3 + title: DisputeEnhancedEvidence + type: object + x-expandableFields: + - visa_compelling_evidence_3 + dispute_enhanced_evidence_visa_compelling_evidence3: + description: '' + properties: + disputed_transaction: + anyOf: + - $ref: >- + #/components/schemas/dispute_visa_compelling_evidence3_disputed_transaction + description: >- + Disputed transaction details for Visa Compelling Evidence 3.0 + evidence submission. + nullable: true + prior_undisputed_transactions: + description: >- + List of exactly two prior undisputed transaction objects for Visa + Compelling Evidence 3.0 evidence submission. + items: + $ref: >- + #/components/schemas/dispute_visa_compelling_evidence3_prior_undisputed_transaction + type: array + required: + - prior_undisputed_transactions + title: DisputeEnhancedEvidenceVisaCompellingEvidence3 + type: object + x-expandableFields: + - disputed_transaction + - prior_undisputed_transactions dispute_evidence: description: '' properties: @@ -11175,6 +12073,8 @@ components: maxLength: 5000 nullable: true type: string + enhanced_evidence: + $ref: '#/components/schemas/dispute_enhanced_evidence' product_description: description: A description of the product or service that was sold. maxLength: 150000 @@ -11300,6 +12200,8 @@ components: maxLength: 150000 nullable: true type: string + required: + - enhanced_evidence title: DisputeEvidence type: object x-expandableFields: @@ -11307,6 +12209,7 @@ components: - customer_communication - customer_signature - duplicate_charge_documentation + - enhanced_evidence - receipt - refund_policy - service_documentation @@ -11323,6 +12226,8 @@ components: format: unix-time nullable: true type: integer + enhanced_eligibility: + $ref: '#/components/schemas/dispute_enhanced_eligibility' has_evidence: description: Whether evidence has been staged for this dispute. type: boolean @@ -11338,12 +12243,14 @@ components: only submit evidence once. type: integer required: + - enhanced_eligibility - has_evidence - past_due - submission_count title: DisputeEvidenceDetails type: object - x-expandableFields: [] + x-expandableFields: + - enhanced_eligibility dispute_payment_method_details: description: '' properties: @@ -11391,7 +12298,7 @@ components: brand: description: >- Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, - `mastercard`, `unionpay`, `visa`, or `unknown`. + `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 type: string case_type: @@ -11446,6 +12353,163 @@ components: title: DisputePaymentMethodDetailsPaypal type: object x-expandableFields: [] + dispute_transaction_shipping_address: + description: '' + properties: + city: + description: 'City, district, suburb, town, or village.' + maxLength: 5000 + nullable: true + type: string + country: + description: >- + Two-letter country code ([ISO 3166-1 + alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + maxLength: 5000 + nullable: true + type: string + line1: + description: 'Address line 1 (e.g., street, PO Box, or company name).' + maxLength: 5000 + nullable: true + type: string + line2: + description: 'Address line 2 (e.g., apartment, suite, unit, or building).' + maxLength: 5000 + nullable: true + type: string + postal_code: + description: ZIP or postal code. + maxLength: 5000 + nullable: true + type: string + state: + description: 'State, county, province, or region.' + maxLength: 5000 + nullable: true + type: string + title: DisputeTransactionShippingAddress + type: object + x-expandableFields: [] + dispute_visa_compelling_evidence3_disputed_transaction: + description: '' + properties: + customer_account_id: + description: >- + User Account ID used to log into business platform. Must be + recognizable by the user. + maxLength: 5000 + nullable: true + type: string + customer_device_fingerprint: + description: >- + Unique identifier of the cardholder’s device derived from a + combination of at least two hardware and software attributes. Must + be at least 20 characters. + maxLength: 5000 + nullable: true + type: string + customer_device_id: + description: >- + Unique identifier of the cardholder’s device such as a device serial + number (e.g., International Mobile Equipment Identity [IMEI]). Must + be at least 15 characters. + maxLength: 5000 + nullable: true + type: string + customer_email_address: + description: The email address of the customer. + maxLength: 5000 + nullable: true + type: string + customer_purchase_ip: + description: The IP address that the customer used when making the purchase. + maxLength: 5000 + nullable: true + type: string + merchandise_or_services: + description: Categorization of disputed payment. + enum: + - merchandise + - services + nullable: true + type: string + product_description: + description: A description of the product or service that was sold. + maxLength: 150000 + nullable: true + type: string + shipping_address: + anyOf: + - $ref: '#/components/schemas/dispute_transaction_shipping_address' + description: >- + The address to which a physical product was shipped. All fields are + required for Visa Compelling Evidence 3.0 evidence submission. + nullable: true + title: DisputeVisaCompellingEvidence3DisputedTransaction + type: object + x-expandableFields: + - shipping_address + dispute_visa_compelling_evidence3_prior_undisputed_transaction: + description: '' + properties: + charge: + description: >- + Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior + charge. + maxLength: 5000 + type: string + customer_account_id: + description: >- + User Account ID used to log into business platform. Must be + recognizable by the user. + maxLength: 5000 + nullable: true + type: string + customer_device_fingerprint: + description: >- + Unique identifier of the cardholder’s device derived from a + combination of at least two hardware and software attributes. Must + be at least 20 characters. + maxLength: 5000 + nullable: true + type: string + customer_device_id: + description: >- + Unique identifier of the cardholder’s device such as a device serial + number (e.g., International Mobile Equipment Identity [IMEI]). Must + be at least 15 characters. + maxLength: 5000 + nullable: true + type: string + customer_email_address: + description: The email address of the customer. + maxLength: 5000 + nullable: true + type: string + customer_purchase_ip: + description: The IP address that the customer used when making the purchase. + maxLength: 5000 + nullable: true + type: string + product_description: + description: A description of the product or service that was sold. + maxLength: 150000 + nullable: true + type: string + shipping_address: + anyOf: + - $ref: '#/components/schemas/dispute_transaction_shipping_address' + description: >- + The address to which a physical product was shipped. All fields are + required for Visa Compelling Evidence 3.0 evidence submission. + nullable: true + required: + - charge + title: DisputeVisaCompellingEvidence3PriorUndisputedTransaction + type: object + x-expandableFields: + - shipping_address email_sent: description: '' properties: @@ -12123,6 +13187,7 @@ components: - dispute_evidence - document_provider_identity_document - finance_report_run + - financial_account_statement - identity_document - identity_document_downloadable - issuing_regulatory_reporting @@ -12916,6 +13981,16 @@ components: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean + metadata: + additionalProperties: + maxLength: 500 + type: string + description: >- + Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + you can attach to an object. This can be useful for storing + additional information about the object in a structured format. + nullable: true + type: object object: description: >- String representing the object's type. Objects of the same type @@ -13069,10 +14144,22 @@ components: funding_instructions_bank_transfer_aba_record: description: ABA Records contain U.S. bank account details per the ABA format. properties: + account_holder_address: + $ref: '#/components/schemas/address' + account_holder_name: + description: The account holder name + maxLength: 5000 + type: string account_number: description: The ABA account number maxLength: 5000 type: string + account_type: + description: The account type + maxLength: 5000 + type: string + bank_address: + $ref: '#/components/schemas/address' bank_name: description: The bank name maxLength: 5000 @@ -13082,12 +14169,18 @@ components: maxLength: 5000 type: string required: + - account_holder_address + - account_holder_name - account_number + - account_type + - bank_address - bank_name - routing_number title: FundingInstructionsBankTransferABARecord type: object - x-expandableFields: [] + x-expandableFields: + - account_holder_address + - bank_address funding_instructions_bank_transfer_financial_address: description: >- FinancialAddresses contain identifying information that resolves to a @@ -13222,10 +14315,22 @@ components: funding_instructions_bank_transfer_swift_record: description: SWIFT Records contain U.S. bank account details per the SWIFT format. properties: + account_holder_address: + $ref: '#/components/schemas/address' + account_holder_name: + description: The account holder name + maxLength: 5000 + type: string account_number: description: The account number maxLength: 5000 type: string + account_type: + description: The account type + maxLength: 5000 + type: string + bank_address: + $ref: '#/components/schemas/address' bank_name: description: The bank name maxLength: 5000 @@ -13235,12 +14340,18 @@ components: maxLength: 5000 type: string required: + - account_holder_address + - account_holder_name - account_number + - account_type + - bank_address - bank_name - swift_code title: FundingInstructionsBankTransferSwiftRecord type: object - x-expandableFields: [] + x-expandableFields: + - account_holder_address + - bank_address funding_instructions_bank_transfer_zengin_record: description: Zengin Records contain Japan bank account details per the Zengin format. properties: @@ -14035,7 +15146,7 @@ components: type: string x-stripeBypassValidation: true verification_flow: - description: The configuration token of a Verification Flow from the dashboard. + description: The configuration token of a verification flow from the dashboard. maxLength: 5000 type: string verification_session: @@ -14218,7 +15329,7 @@ components: nullable: true type: string verification_flow: - description: The configuration token of a Verification Flow from the dashboard. + description: The configuration token of a verification flow from the dashboard. maxLength: 5000 type: string verified_outputs: @@ -15112,6 +16223,15 @@ components: all tax. nullable: true type: integer + total_pretax_credit_amounts: + description: >- + Contains pretax credit amounts (ex: discount, credit grants, etc) + that apply to this invoice. This is a combined list of + total_pretax_credit_amounts across all invoice line items. + items: + $ref: '#/components/schemas/invoices_resource_pretax_credit_amount' + nullable: true + type: array total_tax_amounts: description: The aggregate amounts calculated per tax rate for all line items. items: @@ -15200,6 +16320,7 @@ components: - test_clock - threshold_reason - total_discount_amounts + - total_pretax_credit_amounts - total_tax_amounts - transfer_data x-resourceId: invoice @@ -16190,14 +17311,20 @@ components: - giropay - grabpay - ideal + - jp_credit_transfer + - kakao_pay - konbini + - kr_card - link - multibanco + - naver_pay - p24 + - payco - paynow - paypal - promptpay - revolut_pay + - sepa_credit_transfer - sepa_debit - sofort - swish @@ -16274,12 +17401,13 @@ components: `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, - `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, - `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, - `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, - `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, - `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, - `om_vat`, `de_stn`, `ch_uid`, or `unknown` + `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, + `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, + `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, + `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, + `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, + `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, + `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown` enum: - ad_nrt - ae_trn @@ -16291,6 +17419,7 @@ components: - bo_tin - br_cnpj - br_cpf + - by_tin - ca_bn - ca_gst_hst - ca_pst_bc @@ -16326,6 +17455,9 @@ components: - kr_brn - kz_bin - li_uid + - li_vat + - ma_vat + - md_vat - mx_rfc - my_frp - my_itn @@ -16349,10 +17481,13 @@ components: - th_vat - tr_tin - tw_vat + - tz_vat - ua_vat - unknown - us_ein - uy_ruc + - uz_tin + - uz_vat - ve_rif - vn_tin - za_vat @@ -16400,6 +17535,52 @@ components: type: object x-expandableFields: - credited_items + invoices_resource_pretax_credit_amount: + description: '' + properties: + amount: + description: >- + The amount, in cents (or local equivalent), of the pretax credit + amount. + type: integer + credit_balance_transaction: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/billing.credit_balance_transaction' + description: >- + The credit balance transaction that was applied to get this pretax + credit amount. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/billing.credit_balance_transaction' + discount: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/discount' + - $ref: '#/components/schemas/deleted_discount' + description: The discount that was applied to get this pretax credit amount. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/discount' + - $ref: '#/components/schemas/deleted_discount' + type: + description: Type of the pretax credit amount referenced. + enum: + - credit_balance_transaction + - discount + type: string + x-stripeBypassValidation: true + required: + - amount + - type + title: InvoicesResourcePretaxCreditAmount + type: object + x-expandableFields: + - credit_balance_transaction + - discount invoices_resource_shipping_cost: description: '' properties: @@ -16544,6 +17725,14 @@ components: - $ref: '#/components/schemas/issuing_authorization_fleet_data' description: Fleet-specific information for authorizations using Fleet cards. nullable: true + fraud_challenges: + description: >- + Fraud challenges sent to the cardholder, if this authorization was + declined for fraud risk reasons. + items: + $ref: '#/components/schemas/issuing_authorization_fraud_challenge' + nullable: true + type: array fuel: anyOf: - $ref: '#/components/schemas/issuing_authorization_fuel_data' @@ -16630,6 +17819,7 @@ components: - pending - reversed type: string + x-stripeBypassValidation: true token: anyOf: - maxLength: 5000 @@ -16661,6 +17851,13 @@ components: nullable: true verification_data: $ref: '#/components/schemas/issuing_authorization_verification_data' + verified_by_fraud_challenge: + description: >- + Whether the authorization bypassed fraud risk checks because the + cardholder has previously completed a fraud challenge on a similar + high-risk authorization from the same merchant. + nullable: true + type: boolean wallet: description: >- The digital wallet used for this transaction. One of `apple_pay`, @@ -16696,6 +17893,7 @@ components: - card - cardholder - fleet + - fraud_challenges - fuel - merchant_data - network_data @@ -16709,8 +17907,7 @@ components: issuing.card: description: >- You can [create physical or virtual - cards](https://stripe.com/docs/issuing/cards) that are issued to - cardholders. + cards](https://stripe.com/docs/issuing) that are issued to cardholders. properties: brand: description: The brand of the card. @@ -16906,7 +18103,7 @@ components: Related guide: [How to create a - cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) + cardholder](https://stripe.com/docs/issuing/cards/virtual/issue-cards#create-cardholder) properties: billing: $ref: '#/components/schemas/issuing_cardholder_address' @@ -17944,6 +19141,38 @@ components: title: IssuingAuthorizationFleetTaxData type: object x-expandableFields: [] + issuing_authorization_fraud_challenge: + description: '' + properties: + channel: + description: >- + The method by which the fraud challenge was delivered to the + cardholder. + enum: + - sms + type: string + status: + description: The status of the fraud challenge. + enum: + - expired + - pending + - rejected + - undeliverable + - verified + type: string + undeliverable_reason: + description: 'If the challenge is not deliverable, the reason why.' + enum: + - no_phone_number + - unsupported_phone_number + nullable: true + type: string + required: + - channel + - status + title: IssuingAuthorizationFraudChallenge + type: object + x-expandableFields: [] issuing_authorization_fuel_data: description: '' properties: @@ -22556,6 +23785,14 @@ components: type: string period: $ref: '#/components/schemas/invoice_line_item_period' + pretax_credit_amounts: + description: >- + Contains pretax credit amounts (ex: discount, credit grants, etc) + that apply to this line item. + items: + $ref: '#/components/schemas/invoices_resource_pretax_credit_amount' + nullable: true + type: array price: anyOf: - $ref: '#/components/schemas/price' @@ -22643,6 +23880,7 @@ components: - discounts - invoice_item - period + - pretax_credit_amounts - price - proration_details - subscription @@ -22963,6 +24201,18 @@ components: title: mandate_cashapp type: object x-expandableFields: [] + mandate_kakao_pay: + description: '' + properties: {} + title: mandate_kakao_pay + type: object + x-expandableFields: [] + mandate_kr_card: + description: '' + properties: {} + title: mandate_kr_card + type: object + x-expandableFields: [] mandate_link: description: '' properties: {} @@ -22990,6 +24240,10 @@ components: $ref: '#/components/schemas/card_mandate_payment_method_details' cashapp: $ref: '#/components/schemas/mandate_cashapp' + kakao_pay: + $ref: '#/components/schemas/mandate_kakao_pay' + kr_card: + $ref: '#/components/schemas/mandate_kr_card' link: $ref: '#/components/schemas/mandate_link' paypal: @@ -23019,6 +24273,8 @@ components: - bacs_debit - card - cashapp + - kakao_pay + - kr_card - link - paypal - revolut_pay @@ -23411,18 +24667,29 @@ components: description: '' properties: tip: - $ref: '#/components/schemas/payment_flows_amount_details_resource_tip' + $ref: >- + #/components/schemas/payment_flows_amount_details_client_resource_tip title: PaymentFlowsAmountDetails type: object x-expandableFields: - tip - payment_flows_amount_details_resource_tip: + payment_flows_amount_details_client: + description: '' + properties: + tip: + $ref: >- + #/components/schemas/payment_flows_amount_details_client_resource_tip + title: PaymentFlowsAmountDetailsClient + type: object + x-expandableFields: + - tip + payment_flows_amount_details_client_resource_tip: description: '' properties: amount: description: Portion of the amount that corresponds to a tip. type: integer - title: PaymentFlowsAmountDetailsResourceTip + title: PaymentFlowsAmountDetailsClientResourceTip type: object x-expandableFields: [] payment_flows_automatic_payment_methods_payment_intent: @@ -23608,6 +24875,47 @@ components: title: PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet type: object x-expandableFields: [] + payment_flows_private_payment_methods_kakao_pay_payment_method_options: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a + Customer after the transaction completes. + + + If the payment method is `card_present` and isn't a digital wallet, + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. + + + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). + enum: + - none + - off_session + type: string + title: PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptions + type: object + x-expandableFields: [] payment_flows_private_payment_methods_klarna_dob: description: '' properties: @@ -23626,6 +24934,45 @@ components: title: PaymentFlowsPrivatePaymentMethodsKlarnaDOB type: object x-expandableFields: [] + payment_flows_private_payment_methods_naver_pay_payment_method_options: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + title: PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptions + type: object + x-expandableFields: [] + payment_flows_private_payment_methods_payco_payment_method_options: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + title: PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptions + type: object + x-expandableFields: [] + payment_flows_private_payment_methods_samsung_pay_payment_method_options: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + title: PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptions + type: object + x-expandableFields: [] payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters: description: '' properties: @@ -23685,7 +25032,9 @@ components: description: Amount that can be captured from this PaymentIntent. type: integer amount_details: - $ref: '#/components/schemas/payment_flows_amount_details' + anyOf: + - $ref: '#/components/schemas/payment_flows_amount_details' + - $ref: '#/components/schemas/payment_flows_amount_details_client' amount_received: description: Amount that this PaymentIntent collects. type: integer @@ -23921,8 +25270,9 @@ components: - $ref: >- #/components/schemas/payment_method_config_biz_payment_method_configuration_details description: >- - Information about the payment method configuration used for this - PaymentIntent. + Information about the [payment method + configuration](https://stripe.com/docs/api/payment_method_configurations) + used for this PaymentIntent. nullable: true payment_method_options: anyOf: @@ -24830,6 +26180,11 @@ components: - $ref: '#/components/schemas/payment_method_options_alipay' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + alma: + anyOf: + - $ref: '#/components/schemas/payment_method_options_alma' + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client amazon_pay: anyOf: - $ref: '#/components/schemas/payment_method_options_amazon_pay' @@ -24912,6 +26267,12 @@ components: - $ref: '#/components/schemas/payment_method_options_interac_present' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + kakao_pay: + anyOf: + - $ref: >- + #/components/schemas/payment_flows_private_payment_methods_kakao_pay_payment_method_options + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client klarna: anyOf: - $ref: '#/components/schemas/payment_method_options_klarna' @@ -24922,6 +26283,11 @@ components: - $ref: '#/components/schemas/payment_method_options_konbini' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + kr_card: + anyOf: + - $ref: '#/components/schemas/payment_method_options_kr_card' + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client link: anyOf: - $ref: '#/components/schemas/payment_intent_payment_method_options_link' @@ -24938,6 +26304,12 @@ components: - $ref: '#/components/schemas/payment_method_options_multibanco' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + naver_pay: + anyOf: + - $ref: >- + #/components/schemas/payment_flows_private_payment_methods_naver_pay_payment_method_options + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client oxxo: anyOf: - $ref: '#/components/schemas/payment_method_options_oxxo' @@ -24948,6 +26320,12 @@ components: - $ref: '#/components/schemas/payment_method_options_p24' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + payco: + anyOf: + - $ref: >- + #/components/schemas/payment_flows_private_payment_methods_payco_payment_method_options + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client paynow: anyOf: - $ref: '#/components/schemas/payment_method_options_paynow' @@ -24973,6 +26351,12 @@ components: - $ref: '#/components/schemas/payment_method_options_revolut_pay' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + samsung_pay: + anyOf: + - $ref: >- + #/components/schemas/payment_flows_private_payment_methods_samsung_pay_payment_method_options + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client sepa_debit: anyOf: - $ref: >- @@ -25017,6 +26401,7 @@ components: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -25033,18 +26418,23 @@ components: - grabpay - ideal - interac_present + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -25248,6 +26638,7 @@ components: - girocard - interac - jcb + - link - mastercard - unionpay - unknown @@ -25977,6 +27368,7 @@ components: - affirm - afterpay_clearpay - alipay + - alma - au_becs_debit - bacs_debit - bancontact @@ -26038,6 +27430,7 @@ components: - book - donate - pay + - subscribe type: string subscription_data: anyOf: @@ -27015,6 +28408,8 @@ components: - limited - unspecified type: string + alma: + $ref: '#/components/schemas/payment_method_alma' amazon_pay: $ref: '#/components/schemas/payment_method_amazon_pay' au_becs_debit: @@ -27072,10 +28467,14 @@ components: $ref: '#/components/schemas/payment_method_ideal' interac_present: $ref: '#/components/schemas/payment_method_interac_present' + kakao_pay: + $ref: '#/components/schemas/payment_method_kakao_pay' klarna: $ref: '#/components/schemas/payment_method_klarna' konbini: $ref: '#/components/schemas/payment_method_konbini' + kr_card: + $ref: '#/components/schemas/payment_method_kr_card' link: $ref: '#/components/schemas/payment_method_link' livemode: @@ -27097,6 +28496,8 @@ components: $ref: '#/components/schemas/payment_method_mobilepay' multibanco: $ref: '#/components/schemas/payment_method_multibanco' + naver_pay: + $ref: '#/components/schemas/payment_method_naver_pay' object: description: >- String representing the object's type. Objects of the same type @@ -27108,6 +28509,8 @@ components: $ref: '#/components/schemas/payment_method_oxxo' p24: $ref: '#/components/schemas/payment_method_p24' + payco: + $ref: '#/components/schemas/payment_method_payco' paynow: $ref: '#/components/schemas/payment_method_paynow' paypal: @@ -27120,6 +28523,8 @@ components: $ref: '#/components/schemas/radar_radar_options' revolut_pay: $ref: '#/components/schemas/payment_method_revolut_pay' + samsung_pay: + $ref: '#/components/schemas/payment_method_samsung_pay' sepa_debit: $ref: '#/components/schemas/payment_method_sepa_debit' sofort: @@ -27138,6 +28543,7 @@ components: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -27154,18 +28560,23 @@ components: - grabpay - ideal - interac_present + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -27195,6 +28606,7 @@ components: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -27213,19 +28625,24 @@ components: - grabpay - ideal - interac_present + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - radar_options - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -27279,6 +28696,12 @@ components: title: payment_method_afterpay_clearpay type: object x-expandableFields: [] + payment_method_alma: + description: '' + properties: {} + title: payment_method_alma + type: object + x-expandableFields: [] payment_method_amazon_pay: description: '' properties: {} @@ -27363,7 +28786,7 @@ components: brand: description: >- Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, - `mastercard`, `unionpay`, `visa`, or `unknown`. + `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 type: string checks: @@ -27526,7 +28949,7 @@ components: brand: description: >- Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, - `mastercard`, `unionpay`, `visa`, or `unknown`. + `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 nullable: true type: string @@ -27965,6 +29388,9 @@ components: alipay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties + alma: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties amazon_pay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties @@ -28124,6 +29550,7 @@ components: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - apple_pay - au_becs_debit @@ -28183,6 +29610,8 @@ components: alipay: $ref: >- #/components/schemas/payment_flows_private_payment_methods_alipay_details + alma: + $ref: '#/components/schemas/payment_method_details_alma' amazon_pay: $ref: '#/components/schemas/payment_method_details_amazon_pay' au_becs_debit: @@ -28215,20 +29644,28 @@ components: $ref: '#/components/schemas/payment_method_details_ideal' interac_present: $ref: '#/components/schemas/payment_method_details_interac_present' + kakao_pay: + $ref: '#/components/schemas/payment_method_details_kakao_pay' klarna: $ref: '#/components/schemas/payment_method_details_klarna' konbini: $ref: '#/components/schemas/payment_method_details_konbini' + kr_card: + $ref: '#/components/schemas/payment_method_details_kr_card' link: $ref: '#/components/schemas/payment_method_details_link' mobilepay: $ref: '#/components/schemas/payment_method_details_mobilepay' multibanco: $ref: '#/components/schemas/payment_method_details_multibanco' + naver_pay: + $ref: '#/components/schemas/payment_method_details_naver_pay' oxxo: $ref: '#/components/schemas/payment_method_details_oxxo' p24: $ref: '#/components/schemas/payment_method_details_p24' + payco: + $ref: '#/components/schemas/payment_method_details_payco' paynow: $ref: '#/components/schemas/payment_method_details_paynow' paypal: @@ -28239,6 +29676,8 @@ components: $ref: '#/components/schemas/payment_method_details_promptpay' revolut_pay: $ref: '#/components/schemas/payment_method_details_revolut_pay' + samsung_pay: + $ref: '#/components/schemas/payment_method_details_samsung_pay' sepa_debit: $ref: '#/components/schemas/payment_method_details_sepa_debit' sofort: @@ -28282,6 +29721,7 @@ components: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -28298,18 +29738,23 @@ components: - grabpay - ideal - interac_present + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - stripe_account @@ -28453,6 +29898,12 @@ components: title: payment_method_details_afterpay_clearpay type: object x-expandableFields: [] + payment_method_details_alma: + description: '' + properties: {} + title: payment_method_details_alma + type: object + x-expandableFields: [] payment_method_details_amazon_pay: description: '' properties: {} @@ -28629,7 +30080,7 @@ components: brand: description: >- Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, - `mastercard`, `unionpay`, `visa`, or `unknown`. + `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 nullable: true type: string @@ -28716,7 +30167,8 @@ components: description: >- Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, - `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. + `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or + `unknown`. maxLength: 5000 nullable: true type: string @@ -28850,7 +30302,7 @@ components: brand: description: >- Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, - `mastercard`, `unionpay`, `visa`, or `unknown`. + `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 nullable: true type: string @@ -28956,7 +30408,8 @@ components: description: >- Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, - `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. + `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or + `unknown`. maxLength: 5000 nullable: true type: string @@ -29635,7 +31088,8 @@ components: description: >- Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, - `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. + `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or + `unknown`. maxLength: 5000 nullable: true type: string @@ -29750,6 +31204,19 @@ components: title: payment_method_details_interac_present_receipt type: object x-expandableFields: [] + payment_method_details_kakao_pay: + description: '' + properties: + buyer_id: + description: >- + A unique identifier for the buyer as determined by the local payment + processor. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_kakao_pay + type: object + x-expandableFields: [] payment_method_details_klarna: description: '' properties: @@ -29817,6 +31284,53 @@ components: title: payment_method_details_konbini_store type: object x-expandableFields: [] + payment_method_details_kr_card: + description: '' + properties: + brand: + description: The local credit or debit card brand. + enum: + - bc + - citi + - hana + - hyundai + - jeju + - jeonbuk + - kakaobank + - kbank + - kdbbank + - kookmin + - kwangju + - lotte + - mg + - nh + - post + - samsung + - savingsbank + - shinhan + - shinhyup + - suhyup + - tossbank + - woori + nullable: true + type: string + buyer_id: + description: >- + A unique identifier for the buyer as determined by the local payment + processor. + maxLength: 5000 + nullable: true + type: string + last4: + description: >- + The last four digits of the card. This may not be present for + American Express cards. + maxLength: 4 + nullable: true + type: string + title: payment_method_details_kr_card + type: object + x-expandableFields: [] payment_method_details_link: description: '' properties: @@ -29860,6 +31374,19 @@ components: title: payment_method_details_multibanco type: object x-expandableFields: [] + payment_method_details_naver_pay: + description: '' + properties: + buyer_id: + description: >- + A unique identifier for the buyer as determined by the local payment + processor. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_naver_pay + type: object + x-expandableFields: [] payment_method_details_oxxo: description: '' properties: @@ -29934,6 +31461,19 @@ components: title: payment_method_details_p24 type: object x-expandableFields: [] + payment_method_details_payco: + description: '' + properties: + buyer_id: + description: >- + A unique identifier for the buyer as determined by the local payment + processor. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_payco + type: object + x-expandableFields: [] payment_method_details_paynow: description: '' properties: @@ -30017,6 +31557,19 @@ components: title: payment_method_details_revolut_pay type: object x-expandableFields: [] + payment_method_details_samsung_pay: + description: '' + properties: + buyer_id: + description: >- + A unique identifier for the buyer as determined by the local payment + processor. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_samsung_pay + type: object + x-expandableFields: [] payment_method_details_sepa_debit: description: '' properties: @@ -30281,6 +31834,9 @@ components: Related guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). properties: + amazon_pay: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status apple_pay: $ref: >- #/components/schemas/payment_method_domain_resource_payment_method_status @@ -30326,6 +31882,7 @@ components: $ref: >- #/components/schemas/payment_method_domain_resource_payment_method_status required: + - amazon_pay - apple_pay - created - domain_name @@ -30339,6 +31896,7 @@ components: title: PaymentMethodDomainResourcePaymentMethodDomain type: object x-expandableFields: + - amazon_pay - apple_pay - google_pay - link @@ -30645,6 +32203,12 @@ components: type: object x-expandableFields: - networks + payment_method_kakao_pay: + description: '' + properties: {} + title: payment_method_kakao_pay + type: object + x-expandableFields: [] payment_method_klarna: description: '' properties: @@ -30664,6 +32228,46 @@ components: title: payment_method_konbini type: object x-expandableFields: [] + payment_method_kr_card: + description: '' + properties: + brand: + description: The local credit or debit card brand. + enum: + - bc + - citi + - hana + - hyundai + - jeju + - jeonbuk + - kakaobank + - kbank + - kdbbank + - kookmin + - kwangju + - lotte + - mg + - nh + - post + - samsung + - savingsbank + - shinhan + - shinhyup + - suhyup + - tossbank + - woori + nullable: true + type: string + last4: + description: >- + The last four digits of the card. This may not be present for + American Express cards. + maxLength: 4 + nullable: true + type: string + title: payment_method_kr_card + type: object + x-expandableFields: [] payment_method_link: description: '' properties: @@ -30687,6 +32291,21 @@ components: title: payment_method_multibanco type: object x-expandableFields: [] + payment_method_naver_pay: + description: '' + properties: + funding: + description: Whether to fund this transaction with Naver Pay points or a card. + enum: + - card + - points + type: string + x-stripeBypassValidation: true + required: + - funding + title: payment_method_naver_pay + type: object + x-expandableFields: [] payment_method_options_affirm: description: '' properties: @@ -30818,6 +32437,19 @@ components: title: payment_method_options_alipay type: object x-expandableFields: [] + payment_method_options_alma: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + title: payment_method_options_alma + type: object + x-expandableFields: [] payment_method_options_amazon_pay: description: '' properties: @@ -31496,6 +33128,47 @@ components: title: payment_method_options_konbini type: object x-expandableFields: [] + payment_method_options_kr_card: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a + Customer after the transaction completes. + + + If the payment method is `card_present` and isn't a digital wallet, + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. + + + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). + enum: + - none + - off_session + type: string + title: payment_method_options_kr_card + type: object + x-expandableFields: [] payment_method_options_multibanco: description: '' properties: @@ -32030,6 +33703,12 @@ components: title: payment_method_p24 type: object x-expandableFields: [] + payment_method_payco: + description: '' + properties: {} + title: payment_method_payco + type: object + x-expandableFields: [] payment_method_paynow: description: '' properties: {} @@ -32076,6 +33755,12 @@ components: title: payment_method_revolut_pay type: object x-expandableFields: [] + payment_method_samsung_pay: + description: '' + properties: {} + title: payment_method_samsung_pay + type: object + x-expandableFields: [] payment_method_sepa_debit: description: '' properties: @@ -32263,6 +33948,17 @@ components: title: payment_method_zip type: object x-expandableFields: [] + payment_pages_checkout_session_adaptive_pricing: + description: '' + properties: + enabled: + description: Whether Adaptive Pricing is enabled. + type: boolean + required: + - enabled + title: PaymentPagesCheckoutSessionAdaptivePricing + type: object + x-expandableFields: [] payment_pages_checkout_session_after_expiration: description: '' properties: @@ -33195,12 +34891,13 @@ components: `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, - `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, - `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, - `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, - `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, - `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, - `om_vat`, `de_stn`, `ch_uid`, or `unknown` + `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, + `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, + `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, + `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, + `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, + `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, + `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown` enum: - ad_nrt - ae_trn @@ -33212,6 +34909,7 @@ components: - bo_tin - br_cnpj - br_cpf + - by_tin - ca_bn - ca_gst_hst - ca_pst_bc @@ -33247,6 +34945,9 @@ components: - kr_brn - kz_bin - li_uid + - li_vat + - ma_vat + - md_vat - mx_rfc - my_frp - my_itn @@ -33270,10 +34971,13 @@ components: - th_vat - tr_tin - tw_vat + - tz_vat - ua_vat - unknown - us_ein - uy_ruc + - uz_tin + - uz_vat - ve_rif - vn_tin - za_vat @@ -33585,6 +35289,14 @@ components: show as `paid`, then change to `failed`. maxLength: 5000 type: string + trace_id: + anyOf: + - $ref: '#/components/schemas/payouts_trace_id' + description: >- + A value that generates from the beneficiary's bank that allows users + to track payouts with their bank. Banks might call this a "reference + number" or something similar. + nullable: true type: description: Can be `bank_account` or `card`. enum: @@ -33615,7 +35327,34 @@ components: - failure_balance_transaction - original_payout - reversed_by + - trace_id x-resourceId: payout + payouts_trace_id: + description: '' + properties: + status: + description: >- + Possible values are `pending`, `supported`, and `unsupported`. When + `payout.status` is `pending` or `in_transit`, this will be + `pending`. When the payout transitions to `paid`, `failed`, or + `canceled`, this status will become `supported` or `unsupported` + shortly after in most cases. In some cases, this may appear as + `pending` for up to 10 days after `arrival_date` until transitioning + to `supported` or `unsupported`. + maxLength: 5000 + type: string + value: + description: >- + The trace ID value if `trace_id.status` is `supported`, otherwise + `nil`. + maxLength: 5000 + nullable: true + type: string + required: + - status + title: PayoutsTraceID + type: object + x-expandableFields: [] paypal_seller_protection: description: '' properties: @@ -33738,9 +35477,7 @@ components: - $ref: '#/components/schemas/person_future_requirements' nullable: true gender: - description: >- - The person's gender (International regulations require either "male" - or "female"). + description: The person's gender. nullable: true type: string id: @@ -34700,6 +36437,37 @@ components: title: PortalPaymentMethodUpdate type: object x-expandableFields: [] + portal_resource_schedule_update_at_period_end: + description: '' + properties: + conditions: + description: >- + List of conditions. When any condition is true, an update will be + scheduled at the end of the current period. + items: + $ref: >- + #/components/schemas/portal_resource_schedule_update_at_period_end_condition + type: array + required: + - conditions + title: PortalResourceScheduleUpdateAtPeriodEnd + type: object + x-expandableFields: + - conditions + portal_resource_schedule_update_at_period_end_condition: + description: '' + properties: + type: + description: The type of condition. + enum: + - decreasing_item_amount + - shortening_interval + type: string + required: + - type + title: PortalResourceScheduleUpdateAtPeriodEndCondition + type: object + x-expandableFields: [] portal_subscription_cancel: description: '' properties: @@ -34795,6 +36563,8 @@ components: - create_prorations - none type: string + schedule_at_period_end: + $ref: '#/components/schemas/portal_resource_schedule_update_at_period_end' required: - default_allowed_updates - enabled @@ -34803,6 +36573,7 @@ components: type: object x-expandableFields: - products + - schedule_at_period_end portal_subscription_update_product: description: '' properties: @@ -35288,7 +37059,9 @@ components: code: description: >- The customer-facing code. Regardless of case, this code must be - unique across all active promotion codes for each customer. + unique across all active promotion codes for each customer. Valid + characters are lower case letters (a-z), upper case letters (A-Z), + and digits (0-9). maxLength: 5000 type: string coupon: @@ -36670,14 +38443,16 @@ components: $ref: '#/components/schemas/destination_details_unimplemented' alipay: $ref: '#/components/schemas/destination_details_unimplemented' + alma: + $ref: '#/components/schemas/destination_details_unimplemented' amazon_pay: $ref: '#/components/schemas/destination_details_unimplemented' au_bank_transfer: $ref: '#/components/schemas/destination_details_unimplemented' blik: - $ref: '#/components/schemas/refund_destination_details_generic' + $ref: '#/components/schemas/refund_destination_details_blik' br_bank_transfer: - $ref: '#/components/schemas/refund_destination_details_generic' + $ref: '#/components/schemas/refund_destination_details_br_bank_transfer' card: $ref: '#/components/schemas/refund_destination_details_card' cashapp: @@ -36687,23 +38462,23 @@ components: eps: $ref: '#/components/schemas/destination_details_unimplemented' eu_bank_transfer: - $ref: '#/components/schemas/refund_destination_details_generic' + $ref: '#/components/schemas/refund_destination_details_eu_bank_transfer' gb_bank_transfer: - $ref: '#/components/schemas/refund_destination_details_generic' + $ref: '#/components/schemas/refund_destination_details_gb_bank_transfer' giropay: $ref: '#/components/schemas/destination_details_unimplemented' grabpay: $ref: '#/components/schemas/destination_details_unimplemented' jp_bank_transfer: - $ref: '#/components/schemas/refund_destination_details_generic' + $ref: '#/components/schemas/refund_destination_details_jp_bank_transfer' klarna: $ref: '#/components/schemas/destination_details_unimplemented' multibanco: - $ref: '#/components/schemas/refund_destination_details_generic' + $ref: '#/components/schemas/refund_destination_details_multibanco' mx_bank_transfer: - $ref: '#/components/schemas/refund_destination_details_generic' + $ref: '#/components/schemas/refund_destination_details_mx_bank_transfer' p24: - $ref: '#/components/schemas/refund_destination_details_generic' + $ref: '#/components/schemas/refund_destination_details_p24' paynow: $ref: '#/components/schemas/destination_details_unimplemented' paypal: @@ -36715,9 +38490,9 @@ components: sofort: $ref: '#/components/schemas/destination_details_unimplemented' swish: - $ref: '#/components/schemas/refund_destination_details_generic' + $ref: '#/components/schemas/refund_destination_details_swish' th_bank_transfer: - $ref: '#/components/schemas/refund_destination_details_generic' + $ref: '#/components/schemas/refund_destination_details_th_bank_transfer' type: description: >- The type of transaction-specific details of the payment method used @@ -36727,7 +38502,7 @@ components: maxLength: 5000 type: string us_bank_transfer: - $ref: '#/components/schemas/refund_destination_details_generic' + $ref: '#/components/schemas/refund_destination_details_us_bank_transfer' wechat_pay: $ref: '#/components/schemas/destination_details_unimplemented' zip: @@ -36740,6 +38515,7 @@ components: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_bank_transfer - blik @@ -36767,6 +38543,49 @@ components: - us_bank_transfer - wechat_pay - zip + refund_destination_details_blik: + description: '' + properties: + network_decline_code: + description: >- + For refunds declined by the network, a decline code provided by the + network which indicates the reason the refund failed. + maxLength: 5000 + nullable: true + type: string + reference: + description: The reference assigned to the refund. + maxLength: 5000 + nullable: true + type: string + reference_status: + description: >- + Status of the reference on the refund. This can be `pending`, + `available` or `unavailable`. + maxLength: 5000 + nullable: true + type: string + title: refund_destination_details_blik + type: object + x-expandableFields: [] + refund_destination_details_br_bank_transfer: + description: '' + properties: + reference: + description: The reference assigned to the refund. + maxLength: 5000 + nullable: true + type: string + reference_status: + description: >- + Status of the reference on the refund. This can be `pending`, + `available` or `unavailable`. + maxLength: 5000 + nullable: true + type: string + title: refund_destination_details_br_bank_transfer + type: object + x-expandableFields: [] refund_destination_details_card: description: '' properties: @@ -36796,7 +38615,7 @@ components: title: refund_destination_details_card type: object x-expandableFields: [] - refund_destination_details_generic: + refund_destination_details_eu_bank_transfer: description: '' properties: reference: @@ -36811,17 +38630,165 @@ components: maxLength: 5000 nullable: true type: string - title: refund_destination_details_generic + title: refund_destination_details_eu_bank_transfer + type: object + x-expandableFields: [] + refund_destination_details_gb_bank_transfer: + description: '' + properties: + reference: + description: The reference assigned to the refund. + maxLength: 5000 + nullable: true + type: string + reference_status: + description: >- + Status of the reference on the refund. This can be `pending`, + `available` or `unavailable`. + maxLength: 5000 + nullable: true + type: string + title: refund_destination_details_gb_bank_transfer + type: object + x-expandableFields: [] + refund_destination_details_jp_bank_transfer: + description: '' + properties: + reference: + description: The reference assigned to the refund. + maxLength: 5000 + nullable: true + type: string + reference_status: + description: >- + Status of the reference on the refund. This can be `pending`, + `available` or `unavailable`. + maxLength: 5000 + nullable: true + type: string + title: refund_destination_details_jp_bank_transfer + type: object + x-expandableFields: [] + refund_destination_details_multibanco: + description: '' + properties: + reference: + description: The reference assigned to the refund. + maxLength: 5000 + nullable: true + type: string + reference_status: + description: >- + Status of the reference on the refund. This can be `pending`, + `available` or `unavailable`. + maxLength: 5000 + nullable: true + type: string + title: refund_destination_details_multibanco + type: object + x-expandableFields: [] + refund_destination_details_mx_bank_transfer: + description: '' + properties: + reference: + description: The reference assigned to the refund. + maxLength: 5000 + nullable: true + type: string + reference_status: + description: >- + Status of the reference on the refund. This can be `pending`, + `available` or `unavailable`. + maxLength: 5000 + nullable: true + type: string + title: refund_destination_details_mx_bank_transfer + type: object + x-expandableFields: [] + refund_destination_details_p24: + description: '' + properties: + reference: + description: The reference assigned to the refund. + maxLength: 5000 + nullable: true + type: string + reference_status: + description: >- + Status of the reference on the refund. This can be `pending`, + `available` or `unavailable`. + maxLength: 5000 + nullable: true + type: string + title: refund_destination_details_p24 + type: object + x-expandableFields: [] + refund_destination_details_swish: + description: '' + properties: + network_decline_code: + description: >- + For refunds declined by the network, a decline code provided by the + network which indicates the reason the refund failed. + maxLength: 5000 + nullable: true + type: string + reference: + description: The reference assigned to the refund. + maxLength: 5000 + nullable: true + type: string + reference_status: + description: >- + Status of the reference on the refund. This can be `pending`, + `available` or `unavailable`. + maxLength: 5000 + nullable: true + type: string + title: refund_destination_details_swish + type: object + x-expandableFields: [] + refund_destination_details_th_bank_transfer: + description: '' + properties: + reference: + description: The reference assigned to the refund. + maxLength: 5000 + nullable: true + type: string + reference_status: + description: >- + Status of the reference on the refund. This can be `pending`, + `available` or `unavailable`. + maxLength: 5000 + nullable: true + type: string + title: refund_destination_details_th_bank_transfer + type: object + x-expandableFields: [] + refund_destination_details_us_bank_transfer: + description: '' + properties: + reference: + description: The reference assigned to the refund. + maxLength: 5000 + nullable: true + type: string + reference_status: + description: >- + Status of the reference on the refund. This can be `pending`, + `available` or `unavailable`. + maxLength: 5000 + nullable: true + type: string + title: refund_destination_details_us_bank_transfer type: object x-expandableFields: [] refund_next_action: description: '' properties: display_details: - anyOf: - - $ref: '#/components/schemas/refund_next_action_display_details' - description: Contains the refund details. - nullable: true + $ref: '#/components/schemas/refund_next_action_display_details' type: description: Type of the next action to perform. maxLength: 5000 @@ -37563,8 +39530,12 @@ components: $ref: '#/components/schemas/setup_attempt_payment_method_details_cashapp' ideal: $ref: '#/components/schemas/setup_attempt_payment_method_details_ideal' + kakao_pay: + $ref: '#/components/schemas/setup_attempt_payment_method_details_kakao_pay' klarna: $ref: '#/components/schemas/setup_attempt_payment_method_details_klarna' + kr_card: + $ref: '#/components/schemas/setup_attempt_payment_method_details_kr_card' link: $ref: '#/components/schemas/setup_attempt_payment_method_details_link' paypal: @@ -37602,7 +39573,9 @@ components: - card_present - cashapp - ideal + - kakao_pay - klarna + - kr_card - link - paypal - revolut_pay @@ -37720,7 +39693,7 @@ components: brand: description: >- Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, - `mastercard`, `unionpay`, `visa`, or `unknown`. + `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 nullable: true type: string @@ -37780,7 +39753,8 @@ components: description: >- Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, - `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. + `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or + `unknown`. maxLength: 5000 nullable: true type: string @@ -37980,12 +39954,24 @@ components: x-expandableFields: - generated_sepa_debit - generated_sepa_debit_mandate + setup_attempt_payment_method_details_kakao_pay: + description: '' + properties: {} + title: setup_attempt_payment_method_details_kakao_pay + type: object + x-expandableFields: [] setup_attempt_payment_method_details_klarna: description: '' properties: {} title: setup_attempt_payment_method_details_klarna type: object x-expandableFields: [] + setup_attempt_payment_method_details_kr_card: + description: '' + properties: {} + title: setup_attempt_payment_method_details_kr_card + type: object + x-expandableFields: [] setup_attempt_payment_method_details_link: description: '' properties: {} @@ -38341,8 +40327,9 @@ components: - $ref: >- #/components/schemas/payment_method_config_biz_payment_method_configuration_details description: >- - Information about the payment method configuration used for this - Setup Intent. + Information about the [payment method + configuration](https://stripe.com/docs/api/payment_method_configurations) + used for this Setup Intent. nullable: true payment_method_options: anyOf: @@ -38628,6 +40615,7 @@ components: - girocard - interac - jcb + - link - mastercard - unionpay - unknown @@ -40715,7 +42703,7 @@ components: If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing - collection](/billing/subscriptions/pause-payment). + collection](https://stripe.com/docs/billing/subscriptions/pause-payment). nullable: true payment_settings: anyOf: @@ -40794,12 +42782,13 @@ components: A subscription can only enter a `paused` status [when a trial ends without a payment - method](/billing/subscriptions/trials#create-free-trials-without-payment). + method](https://stripe.com/docs/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing - collection](/billing/subscriptions/pause-payment), which still - generates invoices and leaves the subscription's status unchanged. + collection](https://stripe.com/docs/billing/subscriptions/pause-payment), + which still generates invoices and leaves the subscription's status + unchanged. If subscription `collection_method=charge_automatically`, it becomes @@ -41087,6 +43076,7 @@ components: - girocard - interac - jcb + - link - mastercard - unionpay - unknown @@ -41951,14 +43941,20 @@ components: - giropay - grabpay - ideal + - jp_credit_transfer + - kakao_pay - konbini + - kr_card - link - multibanco + - naver_pay - p24 + - payco - paynow - paypal - promptpay - revolut_pay + - sepa_credit_transfer - sepa_debit - sofort - swish @@ -42423,10 +44419,7 @@ components: - tax.settings type: string status: - description: >- - The `active` status indicates you have all required settings to - calculate tax. A status can transition out of `active` when new - required settings are introduced. + description: The status of the Tax `Settings`. enum: - active - pending @@ -42880,18 +44873,19 @@ components: description: >- Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, - `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, - `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, - `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, - `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, - `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, - `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, - `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, - `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, - `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, - `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, - `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax - IDs have type `unknown` + `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, + `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, + `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, + `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, + `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, + `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, + `li_vat`, `ma_vat`, `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, + `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, + `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, + `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, + `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, + `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some + legacy tax IDs have type `unknown` enum: - ad_nrt - ae_trn @@ -42903,6 +44897,7 @@ components: - bo_tin - br_cnpj - br_cpf + - by_tin - ca_bn - ca_gst_hst - ca_pst_bc @@ -42938,6 +44933,9 @@ components: - kr_brn - kz_bin - li_uid + - li_vat + - ma_vat + - md_vat - mx_rfc - my_frp - my_itn @@ -42961,10 +44959,13 @@ components: - th_vat - tr_tin - tw_vat + - tz_vat - ua_vat - unknown - us_ein - uy_ruc + - uz_tin + - uz_vat - ve_rif - vn_tin - za_vat @@ -43041,6 +45042,9 @@ components: bh: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default + by: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified ca: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_canada @@ -43053,6 +45057,9 @@ components: co: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified + cr: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified cy: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe @@ -43065,6 +45072,9 @@ components: dk: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe + ec: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified ee: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe @@ -43128,6 +45138,12 @@ components: lv: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe + ma: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified + md: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified mt: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe @@ -43161,6 +45177,12 @@ components: ro: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe + rs: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default + ru: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified sa: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified @@ -43182,9 +45204,15 @@ components: tr: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified + tz: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified us: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_united_states + uz: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified vn: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified @@ -43200,14 +45228,17 @@ components: - be - bg - bh + - by - ca - ch - cl - co + - cr - cy - cz - de - dk + - ec - ee - eg - es @@ -43229,6 +45260,8 @@ components: - lt - lu - lv + - ma + - md - mt - mx - my @@ -43240,6 +45273,8 @@ components: - pl - pt - ro + - rs + - ru - sa - se - sg @@ -43247,7 +45282,9 @@ components: - sk - th - tr + - tz - us + - uz - vn - za tax_product_registrations_resource_country_options_ca_province_standard: @@ -43367,6 +45404,7 @@ components: - local_amusement_tax - local_lease_tax - state_communications_tax + - state_retail_delivery_fee - state_sales_tax type: string x-stripeBypassValidation: true @@ -43499,12 +45537,13 @@ components: `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, - `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, - `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, - `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, - `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, - `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, - `om_vat`, `de_stn`, `ch_uid`, or `unknown` + `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, + `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, + `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, + `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, + `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, + `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, + `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown` enum: - ad_nrt - ae_trn @@ -43516,6 +45555,7 @@ components: - bo_tin - br_cnpj - br_cpf + - by_tin - ca_bn - ca_gst_hst - ca_pst_bc @@ -43551,6 +45591,9 @@ components: - kr_brn - kz_bin - li_uid + - li_vat + - ma_vat + - md_vat - mx_rfc - my_frp - my_itn @@ -43574,10 +45617,13 @@ components: - th_vat - tr_tin - tw_vat + - tz_vat - ua_vat - unknown - us_ein - uy_ruc + - uz_tin + - uz_vat - ve_rif - vn_tin - za_vat @@ -43722,8 +45768,10 @@ components: - lease_tax - pst - qst + - retail_delivery_fee - rst - sales_tax + - service_tax - vat type: string x-stripeBypassValidation: true @@ -43898,12 +45946,30 @@ components: maxLength: 5000 nullable: true type: string + flat_amount: + anyOf: + - $ref: '#/components/schemas/tax_rate_flat_amount' + description: >- + The amount of the tax rate when the `rate_type` is `flat_amount`. + Tax rates with `rate_type` `percentage` can vary based on the + transaction, resulting in this field being `null`. This field + exposes the amount and currency of the flat tax rate. + nullable: true percentage_decimal: description: >- The tax rate percentage as a string. For example, 8.5% is represented as `"8.5"`. maxLength: 5000 type: string + rate_type: + description: >- + Indicates the type of tax rate applied to the taxable amount. This + value can be `null` when no tax applies to the location. + enum: + - flat_amount + - percentage + nullable: true + type: string state: description: 'State, county, province, or region.' maxLength: 5000 @@ -43921,8 +45987,10 @@ components: - lease_tax - pst - qst + - retail_delivery_fee - rst - sales_tax + - service_tax - vat nullable: true type: string @@ -43931,7 +45999,8 @@ components: - percentage_decimal title: TaxProductResourceTaxRateDetails type: object - x-expandableFields: [] + x-expandableFields: + - flat_amount tax_product_resource_tax_settings_defaults: description: '' properties: @@ -44130,6 +46199,15 @@ components: corresponding jurisdiction. nullable: true type: number + flat_amount: + anyOf: + - $ref: '#/components/schemas/tax_rate_flat_amount' + description: >- + The amount of the tax rate when the `rate_type` is `flat_amount`. + Tax rates with `rate_type` `percentage` can vary based on the + transaction, resulting in this field being `null`. This field + exposes the amount and currency of the flat tax rate. + nullable: true id: description: Unique identifier for the object. maxLength: 5000 @@ -44185,6 +46263,15 @@ components: automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions. type: number + rate_type: + description: >- + Indicates the type of tax rate applied to the taxable amount. This + value can be `null` when no tax applies to the location. + enum: + - flat_amount + - percentage + nullable: true + type: string state: description: >- [ISO 3166-2 subdivision @@ -44205,8 +46292,10 @@ components: - lease_tax - pst - qst + - retail_delivery_fee - rst - sales_tax + - service_tax - vat nullable: true type: string @@ -44222,8 +46311,35 @@ components: - percentage title: TaxRate type: object - x-expandableFields: [] + x-expandableFields: + - flat_amount x-resourceId: tax_rate + tax_rate_flat_amount: + description: >- + The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax + rates with `rate_type` `percentage` can vary based on the transaction, + resulting in this field being `null`. This field exposes the amount and + currency of the flat tax rate. + properties: + amount: + description: >- + Amount of the tax when the `rate_type` is `flat_amount`. This + positive integer represents how much to charge in the smallest + currency unit (e.g., 100 cents to charge $1.00 or 100 to charge + ¥100, a zero-decimal currency). The amount value supports up to + eight digits (e.g., a value of 99999999 for a USD charge of + $999,999.99). + type: integer + currency: + description: 'Three-letter ISO currency code, in lowercase.' + maxLength: 5000 + type: string + required: + - amount + - currency + title: TaxRateFlatAmount + type: object + x-expandableFields: [] terminal.configuration: description: >- A Configurations object represents how features should be configured for @@ -44593,6 +46709,9 @@ components: nzd: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config + pln: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config sek: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config @@ -44616,6 +46735,7 @@ components: - myr - nok - nzd + - pln - sek - sgd - usd @@ -45162,7 +47282,7 @@ components: title: three_d_secure_usage type: object x-expandableFields: [] - thresholds_resource_alert_filter: + thresholds_resource_usage_alert_filter: description: '' properties: customer: @@ -45175,7 +47295,13 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - title: ThresholdsResourceAlertFilter + type: + enum: + - customer + type: string + required: + - type + title: ThresholdsResourceUsageAlertFilter type: object x-expandableFields: - customer @@ -45184,6 +47310,14 @@ components: The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed. properties: + filters: + description: >- + The filters allow limiting the scope of this usage alert. You can + only specify up to one filter at this time. + items: + $ref: '#/components/schemas/thresholds_resource_usage_alert_filter' + nullable: true + type: array gte: description: The value at which this alert will trigger. type: integer @@ -45209,6 +47343,7 @@ components: title: ThresholdsResourceUsageThresholdConfig type: object x-expandableFields: + - filters - meter token: description: >- @@ -46235,7 +48370,7 @@ components: x-stripeBypassValidation: true type: array status: - description: The enum specifying what state the account is in. + description: Status of this FinancialAccount. enum: - closed - open @@ -46412,6 +48547,7 @@ components: origin_payment_method: description: The origin payment method to be debited for an InboundTransfer. maxLength: 5000 + nullable: true type: string origin_payment_method_details: anyOf: @@ -46443,6 +48579,7 @@ components: - processing - succeeded type: string + x-stripeBypassValidation: true status_transitions: $ref: >- #/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions @@ -46467,7 +48604,6 @@ components: - livemode - metadata - object - - origin_payment_method - statement_descriptor - status - status_transitions @@ -46877,6 +49013,7 @@ components: enum: - account_closed - account_frozen + - international_transaction - other nullable: true type: string @@ -48480,7 +50617,10 @@ components: x-expandableFields: [] x-resourceId: usage_record usage_record_summary: - description: '' + description: >- + A usage record summary represents an aggregated view of how much usage + was accrued for a subscription item within a subscription billing + period. properties: id: description: Unique identifier for the object. @@ -48665,7 +50805,7 @@ info: details. termsOfService: 'https://stripe.com/us/terms/' title: Stripe API - version: '2024-06-20' + version: 2024-10-28.acacia x-stripeSpecFilename: spec3 openapi: 3.0.0 paths: @@ -48707,6 +50847,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve account /v1/account_links: post: description: >- @@ -48806,6 +50947,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create an account link /v1/account_sessions: post: description: >- @@ -48843,6 +50985,8 @@ paths: type: boolean features: properties: + disable_stripe_user_authentication: + type: boolean external_account_collection: type: boolean title: account_features_param @@ -48857,6 +51001,8 @@ paths: type: boolean features: properties: + disable_stripe_user_authentication: + type: boolean external_account_collection: type: boolean title: account_features_param @@ -48871,6 +51017,8 @@ paths: type: boolean features: properties: + disable_stripe_user_authentication: + type: boolean edit_payout_schedule: type: boolean external_account_collection: @@ -48903,6 +51051,8 @@ paths: type: boolean features: properties: + disable_stripe_user_authentication: + type: boolean external_account_collection: type: boolean title: account_features_param @@ -48957,6 +51107,8 @@ paths: type: boolean features: properties: + disable_stripe_user_authentication: + type: boolean edit_payout_schedule: type: boolean external_account_collection: @@ -49033,6 +51185,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create an Account Session /v1/accounts: get: description: >- @@ -49160,6 +51313,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all connected accounts post: description: >-

    With Connect, you can create Stripe @@ -49204,6 +51358,9 @@ paths: expand: explode: true style: deepObject + groups: + explode: true + style: deepObject individual: explode: true style: deepObject @@ -49418,6 +51575,12 @@ paths: type: boolean title: capability_param type: object + alma_payments: + properties: + requested: + type: boolean + title: capability_param + type: object amazon_pay_payments: properties: requested: @@ -49538,6 +51701,12 @@ paths: type: boolean title: capability_param type: object + kakao_pay_payments: + properties: + requested: + type: boolean + title: capability_param + type: object klarna_payments: properties: requested: @@ -49550,6 +51719,12 @@ paths: type: boolean title: capability_param type: object + kr_card_payments: + properties: + requested: + type: boolean + title: capability_param + type: object legacy_payments: properties: requested: @@ -49580,6 +51755,12 @@ paths: type: boolean title: capability_param type: object + naver_pay_payments: + properties: + requested: + type: boolean + title: capability_param + type: object oxxo_payments: properties: requested: @@ -49592,6 +51773,12 @@ paths: type: boolean title: capability_param type: object + payco_payments: + properties: + requested: + type: boolean + title: capability_param + type: object paynow_payments: properties: requested: @@ -49610,6 +51797,12 @@ paths: type: boolean title: capability_param type: object + samsung_pay_payments: + properties: + requested: + type: boolean + title: capability_param + type: object sepa_bank_transfer_payments: properties: requested: @@ -50028,6 +52221,20 @@ paths: maxLength: 5000 type: string x-stripeBypassValidation: true + groups: + description: >- + A hash of account group type to tokens. These are account + groups this account should be added to + properties: + payments_pricing: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: account_groups_specs + type: object individual: description: >- Information about the person represented by the account. @@ -50520,6 +52727,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete an account get: description:

    Retrieves the details of an account.

    operationId: GetAccountsAccount @@ -50564,6 +52772,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve account post: description: >-

    Updates a connected account by @@ -50627,6 +52836,9 @@ paths: expand: explode: true style: deepObject + groups: + explode: true + style: deepObject individual: explode: true style: deepObject @@ -50781,6 +52993,12 @@ paths: type: boolean title: capability_param type: object + alma_payments: + properties: + requested: + type: boolean + title: capability_param + type: object amazon_pay_payments: properties: requested: @@ -50901,6 +53119,12 @@ paths: type: boolean title: capability_param type: object + kakao_pay_payments: + properties: + requested: + type: boolean + title: capability_param + type: object klarna_payments: properties: requested: @@ -50913,6 +53137,12 @@ paths: type: boolean title: capability_param type: object + kr_card_payments: + properties: + requested: + type: boolean + title: capability_param + type: object legacy_payments: properties: requested: @@ -50943,6 +53173,12 @@ paths: type: boolean title: capability_param type: object + naver_pay_payments: + properties: + requested: + type: boolean + title: capability_param + type: object oxxo_payments: properties: requested: @@ -50955,6 +53191,12 @@ paths: type: boolean title: capability_param type: object + payco_payments: + properties: + requested: + type: boolean + title: capability_param + type: object paynow_payments: properties: requested: @@ -50973,6 +53215,12 @@ paths: type: boolean title: capability_param type: object + samsung_pay_payments: + properties: + requested: + type: boolean + title: capability_param + type: object sepa_bank_transfer_payments: properties: requested: @@ -51336,6 +53584,20 @@ paths: maxLength: 5000 type: string x-stripeBypassValidation: true + groups: + description: >- + A hash of account group type to tokens. These are account + groups this account should be added to + properties: + payments_pricing: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: account_groups_specs + type: object individual: description: >- Information about the person represented by the account. @@ -51781,6 +54043,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update an account '/v1/accounts/{account}/bank_accounts': post: description:

    Create an external account for a given account.

    @@ -51915,6 +54178,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create an external account '/v1/accounts/{account}/bank_accounts/{id}': delete: description:

    Delete a specified external account for a given account.

    @@ -51955,6 +54219,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete an external account get: description:

    Retrieve a specified external account for a given account.

    operationId: GetAccountsAccountBankAccountsId @@ -52005,6 +54270,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an external account post: description: >-

    Updates the metadata, account holder name, account holder type of a @@ -52257,6 +54523,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all account capabilities '/v1/accounts/{account}/capabilities/{capability}': get: description:

    Retrieves information about the specified Account Capability.

    @@ -52308,6 +54575,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an Account Capability post: description: >-

    Updates an existing Account Capability. Request or remove a @@ -52371,6 +54639,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update an Account Capability '/v1/accounts/{account}/external_accounts': get: description:

    List external accounts for an account.

    @@ -52499,6 +54768,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all external accounts post: description:

    Create an external account for a given account.

    operationId: PostAccountsAccountExternalAccounts @@ -52632,6 +54902,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create an external account '/v1/accounts/{account}/external_accounts/{id}': delete: description:

    Delete a specified external account for a given account.

    @@ -52672,6 +54943,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete an external account get: description:

    Retrieve a specified external account for a given account.

    operationId: GetAccountsAccountExternalAccountsId @@ -52722,6 +54994,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an external account post: description: >-

    Updates the metadata, account holder name, account holder type of a @@ -52899,8 +55172,8 @@ paths: '/v1/accounts/{account}/login_links': post: description: >- -

    Creates a single-use login link for a connected account to access the - Express Dashboard.

    +

    Creates a login link for a connected account to access the Express + Dashboard.

    You can only create login links for accounts that use the - @@ -53081,6 +55355,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all persons post: description:

    Creates a new person.

    operationId: PostAccountsAccountPeople @@ -53507,6 +55782,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a person '/v1/accounts/{account}/people/{person}': delete: description: >- @@ -53554,6 +55830,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a person get: description:

    Retrieves an existing person.

    operationId: GetAccountsAccountPeoplePerson @@ -53605,6 +55882,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a person post: description:

    Updates an existing person.

    operationId: PostAccountsAccountPeoplePerson @@ -54038,6 +56316,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a person '/v1/accounts/{account}/persons': get: description: >- @@ -54173,6 +56452,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all persons post: description:

    Creates a new person.

    operationId: PostAccountsAccountPersons @@ -54599,6 +56879,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a person '/v1/accounts/{account}/persons/{person}': delete: description: >- @@ -54646,6 +56927,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a person get: description:

    Retrieves an existing person.

    operationId: GetAccountsAccountPersonsPerson @@ -54697,6 +56979,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a person post: description:

    Updates an existing person.

    operationId: PostAccountsAccountPersonsPerson @@ -55130,6 +57413,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a person '/v1/accounts/{account}/reject': post: description: >- @@ -55189,6 +57473,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Reject an account /v1/apple_pay/domains: get: description:

    List apple pay domains.

    @@ -55555,6 +57840,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all application fees '/v1/application_fees/{fee}/refunds/{id}': get: description: >- @@ -55610,6 +57896,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an application fee refund post: description: >-

    Updates the specified application fee refund by setting the values of @@ -55684,6 +57971,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update an application fee refund '/v1/application_fees/{id}': get: description: >- @@ -55732,6 +58020,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an application fee '/v1/application_fees/{id}/refund': post: description: '' @@ -55897,6 +58186,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all application fee refunds post: description: >-

    Refunds an application fee that has previously been collected but not @@ -55980,6 +58270,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create an application fee refund /v1/apps/secrets: get: description:

    List all secrets stored on the given scope.

    @@ -56107,6 +58398,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List secrets post: description:

    Create or replace a secret in the secret store.

    operationId: PostAppsSecrets @@ -56180,6 +58472,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Set a Secret /v1/apps/secrets/delete: post: description:

    Deletes a secret from the secret store by name and scope.

    @@ -56243,6 +58536,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a Secret /v1/apps/secrets/find: get: description:

    Finds a secret in the secret store by name and scope.

    @@ -56312,6 +58606,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Find a Secret /v1/balance: get: description: >- @@ -56353,6 +58648,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve balance /v1/balance/history: get: description: >- @@ -56539,6 +58835,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all balance transactions '/v1/balance/history/{id}': get: description: >- @@ -56589,6 +58886,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a balance transaction /v1/balance_transactions: get: description: >- @@ -56775,6 +59073,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all balance transactions '/v1/balance_transactions/{id}': get: description: >- @@ -56825,6 +59124,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a balance transaction /v1/billing/alerts: get: description:

    Lists billing active and inactive alerts

    @@ -56873,14 +59173,636 @@ paths: schema: type: integer style: form - - description: Filter results to only include alerts with the given meter. + - description: Filter results to only include alerts with the given meter. + in: query + name: meter + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + A cursor for use in pagination. `starting_after` is an object ID + that defines your place in the list. For instance, if you make a + list request and receive 100 objects, ending with `obj_foo`, your + subsequent call can include `starting_after=obj_foo` in order to + fetch the next page of the list. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/billing.alert' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/billing/alerts + type: string + required: + - data + - has_more + - object + - url + title: ThresholdsResourceAlertList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: List billing alerts + post: + description:

    Creates a billing alert

    + operationId: PostBillingAlerts + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + usage_threshold: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + alert_type: + description: The type of alert to create. + enum: + - usage_threshold + type: string + x-stripeBypassValidation: true + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + title: + description: The title of the alert. + maxLength: 256 + type: string + usage_threshold: + description: The configuration of the usage threshold. + properties: + filters: + items: + properties: + customer: + maxLength: 5000 + type: string + type: + enum: + - customer + type: string + required: + - type + title: usage_alert_filter + type: object + type: array + gte: + type: integer + meter: + maxLength: 5000 + type: string + recurrence: + enum: + - one_time + type: string + x-stripeBypassValidation: true + required: + - gte + - recurrence + title: usage_threshold_config + type: object + required: + - alert_type + - title + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing.alert' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Create a billing alert + '/v1/billing/alerts/{id}': + get: + description:

    Retrieves a billing alert given an ID

    + operationId: GetBillingAlertsId + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing.alert' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Retrieve a billing alert + '/v1/billing/alerts/{id}/activate': + post: + description: '

    Reactivates this alert, allowing it to trigger again.

    ' + operationId: PostBillingAlertsIdActivate + parameters: + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing.alert' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Activate a billing alert + '/v1/billing/alerts/{id}/archive': + post: + description: >- +

    Archives this alert, removing it from the list view and APIs. This is + non-reversible.

    + operationId: PostBillingAlertsIdArchive + parameters: + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing.alert' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Archive a billing alert + '/v1/billing/alerts/{id}/deactivate': + post: + description: '

    Deactivates this alert, preventing it from triggering.

    ' + operationId: PostBillingAlertsIdDeactivate + parameters: + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing.alert' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Deactivate a billing alert + /v1/billing/credit_balance_summary: + get: + description:

    Retrieves the credit balance summary for a customer

    + operationId: GetBillingCreditBalanceSummary + parameters: + - description: The customer for which to fetch credit balance summary. + in: query + name: customer + required: true + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: The filter criteria for the credit balance summary. + explode: true + in: query + name: filter + required: true + schema: + properties: + applicability_scope: + properties: + price_type: + enum: + - metered + type: string + required: + - price_type + title: scope_param + type: object + credit_grant: + maxLength: 5000 + type: string + type: + enum: + - applicability_scope + - credit_grant + type: string + required: + - type + title: balance_summary_filter_param + type: object + style: deepObject + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing.credit_balance_summary' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Retrieve the credit balance summary for a customer + /v1/billing/credit_balance_transactions: + get: + description:

    Retrieve a list of credit balance transactions

    + operationId: GetBillingCreditBalanceTransactions + parameters: + - description: The credit grant for which to fetch credit balance transactions. + in: query + name: credit_grant + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: The customer for which to fetch credit balance transactions. + in: query + name: customer + required: true + schema: + maxLength: 5000 + type: string + style: form + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: >- + A cursor for use in pagination. `starting_after` is an object ID + that defines your place in the list. For instance, if you make a + list request and receive 100 objects, ending with `obj_foo`, your + subsequent call can include `starting_after=obj_foo` in order to + fetch the next page of the list. in: query - name: meter + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/billing.credit_balance_transaction' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/billing/credit_grants + type: string + required: + - data + - has_more + - object + - url + title: BillingCreditGrantsResourceBalanceTransactionList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: List credit balance transactions + '/v1/billing/credit_balance_transactions/{id}': + get: + description:

    Retrieves a credit balance transaction

    + operationId: GetBillingCreditBalanceTransactionsId + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: Unique identifier for the object. + in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing.credit_balance_transaction' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Retrieve a credit balance transaction + /v1/billing/credit_grants: + get: + description:

    Retrieve a list of credit grants.

    + operationId: GetBillingCreditGrants + parameters: + - description: Only return credit grants for this customer. + in: query + name: customer required: false schema: maxLength: 5000 type: string style: form + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a @@ -56912,7 +59834,7 @@ paths: properties: data: items: - $ref: '#/components/schemas/billing.alert' + $ref: '#/components/schemas/billing.credit_grant' type: array has_more: description: >- @@ -56929,14 +59851,14 @@ paths: url: description: The URL where this list can be accessed. maxLength: 5000 - pattern: ^/v1/billing/alerts + pattern: ^/v1/billing/credit_grants type: string required: - data - has_more - object - url - title: ThresholdsResourceAlertList + title: BillingCreditGrantsResourceCreditGrantList type: object x-expandableFields: - data @@ -56947,76 +59869,114 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List credit grants post: - description:

    Creates a billing alert

    - operationId: PostBillingAlerts + description:

    Creates a credit grant

    + operationId: PostBillingCreditGrants requestBody: content: application/x-www-form-urlencoded: encoding: - expand: + amount: explode: true style: deepObject - filter: + applicability_config: explode: true style: deepObject - usage_threshold_config: + expand: + explode: true + style: deepObject + metadata: explode: true style: deepObject schema: additionalProperties: false properties: - alert_type: - description: The type of alert to create. + amount: + description: Amount of this credit grant. + properties: + monetary: + properties: + currency: + type: string + value: + type: integer + required: + - currency + - value + title: monetary_amount_param + type: object + type: + enum: + - monetary + type: string + required: + - type + title: amount_param + type: object + applicability_config: + description: Configuration specifying what this credit grant applies to. + properties: + scope: + properties: + price_type: + enum: + - metered + type: string + required: + - price_type + title: scope_param + type: object + required: + - scope + title: applicability_config_param + type: object + category: + description: The category of this credit grant. enum: - - usage_threshold + - paid + - promotional type: string - x-stripeBypassValidation: true + customer: + description: ID of the customer to receive the billing credits. + maxLength: 5000 + type: string + effective_at: + description: >- + The time when the billing credits become effective—when + they're eligible for use. Defaults to the current timestamp + if not specified. + format: unix-time + type: integer expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array - filter: - description: Filters to limit the scope of an alert. - properties: - customer: - maxLength: 5000 - type: string - subscription: - maxLength: 5000 - type: string - subscription_item: - maxLength: 5000 - type: string - title: alert_filter + expires_at: + description: >- + The time when the billing credits will expire. If not + specified, the billing credits don't expire. + format: unix-time + type: integer + metadata: + additionalProperties: + type: string + description: >- + Set of key-value pairs that you can attach to an object. + This can be useful for storing additional information about + the object (for example, cost basis) in a structured format. type: object - title: - description: The title of the alert. - maxLength: 256 + name: + description: A descriptive name shown in the Dashboard. + maxLength: 100 type: string - usage_threshold_config: - description: The configuration of the usage threshold. - properties: - gte: - type: integer - meter: - maxLength: 5000 - type: string - recurrence: - enum: - - one_time - type: string - x-stripeBypassValidation: true - required: - - gte - - recurrence - title: usage_threshold_config - type: object required: - - alert_type - - title + - amount + - applicability_config + - category + - customer type: object required: true responses: @@ -57024,7 +59984,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/billing.alert' + $ref: '#/components/schemas/billing.credit_grant' description: Successful response. default: content: @@ -57032,10 +59992,11 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/billing/alerts/{id}': + summary: Create a credit grant + '/v1/billing/credit_grants/{id}': get: - description:

    Retrieves a billing alert given an ID

    - operationId: GetBillingAlertsId + description:

    Retrieves a credit grant

    + operationId: GetBillingCreditGrantsId parameters: - description: Specifies which fields in the response should be expanded. explode: true @@ -57048,7 +60009,8 @@ paths: type: string type: array style: deepObject - - in: path + - description: Unique identifier for the object. + in: path name: id required: true schema: @@ -57069,7 +60031,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/billing.alert' + $ref: '#/components/schemas/billing.credit_grant' description: Successful response. default: content: @@ -57077,12 +60039,13 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/billing/alerts/{id}/activate': + summary: Retrieve a credit grant post: - description: '

    Reactivates this alert, allowing it to trigger again.

    ' - operationId: PostBillingAlertsIdActivate + description:

    Updates a credit grant

    + operationId: PostBillingCreditGrantsId parameters: - - in: path + - description: Unique identifier for the object. + in: path name: id required: true schema: @@ -57096,6 +60059,12 @@ paths: expand: explode: true style: deepObject + expires_at: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject schema: additionalProperties: false properties: @@ -57105,6 +60074,25 @@ paths: maxLength: 5000 type: string type: array + expires_at: + anyOf: + - format: unix-time + type: integer + - enum: + - '' + type: string + description: >- + The time when the billing credits created by this credit + grant expire. If set to empty, the billing credits never + expire. + metadata: + additionalProperties: + type: string + description: >- + Set of key-value pairs you can attach to an object. This can + be useful for storing additional information about the + object (for example, cost basis) in a structured format. + type: object type: object required: false responses: @@ -57112,7 +60100,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/billing.alert' + $ref: '#/components/schemas/billing.credit_grant' description: Successful response. default: content: @@ -57120,14 +60108,14 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/billing/alerts/{id}/archive': + summary: Update a credit grant + '/v1/billing/credit_grants/{id}/expire': post: - description: >- -

    Archives this alert, removing it from the list view and APIs. This is - non-reversible.

    - operationId: PostBillingAlertsIdArchive + description:

    Expires a credit grant.

    + operationId: PostBillingCreditGrantsIdExpire parameters: - - in: path + - description: Unique identifier for the object. + in: path name: id required: true schema: @@ -57157,7 +60145,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/billing.alert' + $ref: '#/components/schemas/billing.credit_grant' description: Successful response. default: content: @@ -57165,12 +60153,14 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/billing/alerts/{id}/deactivate': + summary: Expire a credit grant + '/v1/billing/credit_grants/{id}/void': post: - description: '

    Deactivates this alert, preventing it from triggering.

    ' - operationId: PostBillingAlertsIdDeactivate + description:

    Voids a credit grant.

    + operationId: PostBillingCreditGrantsIdVoid parameters: - - in: path + - description: Unique identifier for the object. + in: path name: id required: true schema: @@ -57200,7 +60190,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/billing.alert' + $ref: '#/components/schemas/billing.credit_grant' description: Successful response. default: content: @@ -57208,6 +60198,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Void a credit grant /v1/billing/meter_event_adjustments: post: description:

    Creates a billing meter event adjustment

    @@ -57271,6 +60262,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a billing meter event adjustment /v1/billing/meter_events: post: description:

    Creates a billing meter event

    @@ -57303,9 +60295,13 @@ paths: identifier: description: >- A unique identifier for the event. If not provided, one will - be generated. We recommend using a globally unique - identifier for this. We'll enforce uniqueness within a - rolling 24 hour period. + be generated. We strongly advise using UUID-like + identifiers. We will enforce uniqueness within a rolling + period of at least 24 hours. The enforcement of uniqueness + primarily addresses issues arising from accidental retries + or other problems occurring within extremely brief time + intervals. This approach helps prevent duplicate entries and + ensures data integrity in high-frequency operations. maxLength: 100 type: string payload: @@ -57345,6 +60341,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a billing meter event /v1/billing/meters: get: description:

    Retrieve a list of billing meters.

    @@ -57459,6 +60456,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List billing meters post: description:

    Creates a billing meter

    operationId: PostBillingMeters @@ -57559,6 +60557,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a billing meter '/v1/billing/meters/{id}': get: description:

    Retrieves a billing meter given an ID

    @@ -57605,6 +60604,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a billing meter post: description:

    Updates a billing meter

    operationId: PostBillingMetersId @@ -57652,6 +60652,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a billing meter '/v1/billing/meters/{id}/deactivate': post: description:

    Deactivates a billing meter

    @@ -57696,6 +60697,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Deactivate a billing meter '/v1/billing/meters/{id}/event_summaries': get: description:

    Retrieve a list of billing meter event summaries.

    @@ -57852,6 +60854,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List billing meter event summaries '/v1/billing/meters/{id}/reactivate': post: description:

    Reactivates a billing meter

    @@ -57896,6 +60899,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Reactivate a billing meter /v1/billing_portal/configurations: get: description: >- @@ -58020,6 +61024,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List portal configurations post: description: >-

    Creates a configuration that describes the functionality and behavior @@ -58213,10 +61218,25 @@ paths: - create_prorations - none type: string + schedule_at_period_end: + properties: + conditions: + items: + properties: + type: + enum: + - decreasing_item_amount + - shortening_interval + type: string + required: + - type + title: schedule_update_at_period_end_condition_param + type: object + type: array + title: schedule_update_at_period_end_creating_param + type: object required: - - default_allowed_updates - enabled - - products title: subscription_update_creation_param type: object title: features_creation_param @@ -58246,7 +61266,6 @@ paths: value to `metadata`. type: object required: - - business_profile - features type: object required: true @@ -58263,6 +61282,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a portal configuration '/v1/billing_portal/configurations/{configuration}': get: description: >- @@ -58310,6 +61330,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a portal configuration post: description: >-

    Updates a configuration that describes the functionality of the @@ -58519,6 +61540,28 @@ paths: - create_prorations - none type: string + schedule_at_period_end: + properties: + conditions: + anyOf: + - items: + properties: + type: + enum: + - decreasing_item_amount + - shortening_interval + type: string + required: + - type + title: >- + schedule_update_at_period_end_condition_param + type: object + type: array + - enum: + - '' + type: string + title: schedule_update_at_period_end_updating_param + type: object title: subscription_update_updating_param type: object title: features_updating_param @@ -58566,6 +61609,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a portal configuration /v1/billing_portal/sessions: post: description:

    Creates a session of the customer portal.

    @@ -58812,6 +61856,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a portal session /v1/charges: get: description: >- @@ -58965,6 +62010,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all charges post: description: >-

    This method is no longer recommended—use the - @@ -59477,6 +62524,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a charge post: description: >-

    Updates the specified charge by setting the values of the parameters @@ -59642,6 +62690,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a charge '/v1/charges/{charge}/capture': post: description: >- @@ -59767,6 +62816,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Capture a payment '/v1/charges/{charge}/dispute': get: description:

    Retrieve a dispute for a specified charge.

    @@ -59881,6 +62931,216 @@ paths: duplicate_charge_id: maxLength: 5000 type: string + enhanced_evidence: + anyOf: + - properties: + visa_compelling_evidence_3: + properties: + disputed_transaction: + properties: + customer_account_id: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_device_fingerprint: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_device_id: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_email_address: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_purchase_ip: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + merchandise_or_services: + enum: + - merchandise + - services + type: string + product_description: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + shipping_address: + properties: + city: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + country: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + line1: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + line2: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + postal_code: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + state: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: shipping_address + type: object + title: >- + visa_compelling_evidence3_disputed_transaction + type: object + prior_undisputed_transactions: + items: + properties: + charge: + maxLength: 5000 + type: string + customer_account_id: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_device_fingerprint: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_device_id: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_email_address: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_purchase_ip: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + product_description: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + shipping_address: + properties: + city: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + country: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + line1: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + line2: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + postal_code: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + state: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: shipping_address + type: object + required: + - charge + title: >- + visa_compelling_evidence3_prior_undisputed_transaction + type: object + type: array + title: visa_compelling_evidence3 + type: object + title: enhanced_evidence + type: object + - enum: + - '' + type: string product_description: maxLength: 20000 type: string @@ -60143,6 +63403,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a refund '/v1/charges/{charge}/refunds': get: description: >- @@ -60256,6 +63517,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all refunds post: description: >-

    When you create a new refund, you must specify a Charge or a @@ -60402,6 +63664,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create customer balance refund '/v1/charges/{charge}/refunds/{refund}': get: description:

    Retrieves the details of an existing refund.

    @@ -60694,6 +63957,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all Checkout Sessions post: description:

    Creates a Session object.

    operationId: PostCheckoutSessions @@ -60701,6 +63965,9 @@ paths: content: application/x-www-form-urlencoded: encoding: + adaptive_pricing: + explode: true + style: deepObject after_expiration: explode: true style: deepObject @@ -60770,6 +64037,15 @@ paths: schema: additionalProperties: false properties: + adaptive_pricing: + description: >- + Settings for price localization with [Adaptive + Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). + properties: + enabled: + type: boolean + title: adaptive_pricing_params + type: object after_expiration: description: Configure actions after a Checkout Session has expired. properties: @@ -61642,6 +64918,10 @@ paths: type: object bacs_debit: properties: + mandate_options: + properties: {} + title: payment_method_options_mandate_options_param + type: object setup_future_usage: enum: - none @@ -61678,6 +64958,26 @@ paths: type: boolean title: installments_param type: object + request_extended_authorization: + enum: + - if_available + - never + type: string + request_incremental_authorization: + enum: + - if_available + - never + type: string + request_multicapture: + enum: + - if_available + - never + type: string + request_overcapture: + enum: + - if_available + - never + type: string request_three_d_secure: enum: - any @@ -61797,6 +65097,19 @@ paths: type: string title: payment_method_options_param type: object + kakao_pay: + properties: + capture_method: + enum: + - manual + type: string + setup_future_usage: + enum: + - none + - off_session + type: string + title: payment_method_options_param + type: object klarna: properties: setup_future_usage: @@ -61815,6 +65128,19 @@ paths: type: string title: payment_method_options_param type: object + kr_card: + properties: + capture_method: + enum: + - manual + type: string + setup_future_usage: + enum: + - none + - off_session + type: string + title: payment_method_options_param + type: object link: properties: setup_future_usage: @@ -61840,6 +65166,19 @@ paths: type: string title: payment_method_options_param type: object + naver_pay: + properties: + capture_method: + enum: + - manual + type: string + setup_future_usage: + enum: + - none + - off_session + type: string + title: payment_method_options_param + type: object oxxo: properties: expires_after_days: @@ -61860,6 +65199,14 @@ paths: type: boolean title: payment_method_options_param type: object + payco: + properties: + capture_method: + enum: + - manual + type: string + title: payment_method_options_param + type: object paynow: properties: setup_future_usage: @@ -61929,8 +65276,20 @@ paths: type: string title: payment_method_options_param type: object + samsung_pay: + properties: + capture_method: + enum: + - manual + type: string + title: payment_method_options_param + type: object sepa_debit: properties: + mandate_options: + properties: {} + title: payment_method_options_mandate_options_param + type: object setup_future_usage: enum: - none @@ -62051,6 +65410,7 @@ paths: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -62065,18 +65425,23 @@ paths: - giropay - grabpay - ideal + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -62532,6 +65897,7 @@ paths: - book - donate - pay + - subscribe type: string subscription_data: description: >- @@ -62667,6 +66033,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a Session '/v1/checkout/sessions/{session}': get: description:

    Retrieves a Session object.

    @@ -62712,6 +66079,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Session post: description:

    Updates a Session object.

    operationId: PostCheckoutSessionsSession @@ -62773,6 +66141,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a Session '/v1/checkout/sessions/{session}/expire': post: description: >- @@ -62822,6 +66191,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Expire a Session '/v1/checkout/sessions/{session}/line_items': get: description: >- @@ -62937,6 +66307,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Checkout Session's line items /v1/climate/orders: get: description: >- @@ -63045,6 +66416,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List orders post: description: >-

    Creates a Climate order object for a given Climate product. The order @@ -63140,6 +66512,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create an order '/v1/climate/orders/{order}': get: description: >- @@ -63188,6 +66561,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an order post: description: >-

    Updates the specified order by setting the values of the parameters @@ -63271,6 +66645,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update an order '/v1/climate/orders/{order}/cancel': post: description: >- @@ -63326,6 +66701,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Cancel an order /v1/climate/products: get: description:

    Lists all available Climate product objects.

    @@ -63430,6 +66806,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List products '/v1/climate/products/{product}': get: description:

    Retrieves the details of a Climate product with the given ID.

    @@ -63475,6 +66852,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a product /v1/climate/suppliers: get: description:

    Lists all available Climate supplier objects.

    @@ -63579,6 +66957,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List suppliers '/v1/climate/suppliers/{supplier}': get: description:

    Retrieves a Climate supplier object.

    @@ -63624,6 +67003,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a supplier '/v1/confirmation_tokens/{confirmation_token}': get: description:

    Retrieves an existing ConfirmationToken object

    @@ -63669,6 +67049,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a ConfirmationToken /v1/country_specs: get: description:

    Lists all Country Spec objects available in the API.

    @@ -63773,6 +67154,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List Country Specs '/v1/country_specs/{country}': get: description:

    Returns a Country Spec for a given Country code.

    @@ -63818,6 +67200,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Country Spec /v1/coupons: get: description:

    Returns a list of your coupons.

    @@ -63945,6 +67328,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all coupons post: description: >-

    You can create coupons easily via the - @@ -64150,6 +67535,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a coupon get: description:

    Retrieves the coupon with the given ID.

    operationId: GetCouponsCoupon @@ -64194,6 +67580,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a coupon post: description: >-

    Updates the metadata of a coupon. Other coupon details (currency, @@ -64283,6 +67670,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a coupon /v1/credit_notes: get: description:

    Returns a list of credit notes.

    @@ -64428,6 +67816,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all credit notes post: description: >-

    Issue a credit note to adjust the amount of a finalized invoice. For @@ -64648,6 +68037,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a credit note /v1/credit_notes/preview: get: description:

    Get a preview of a credit note without creating it.

    @@ -64878,6 +68268,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Preview a credit note /v1/credit_notes/preview/lines: get: description: >- @@ -65178,6 +68569,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a credit note preview's line items '/v1/credit_notes/{credit_note}/lines': get: description: >- @@ -65292,6 +68684,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a credit note's line items '/v1/credit_notes/{id}': get: description:

    Retrieves the credit note object with the given identifier.

    @@ -65337,6 +68730,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a credit note post: description:

    Updates an existing credit note.

    operationId: PostCreditNotesId @@ -65398,6 +68792,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a credit note '/v1/credit_notes/{id}/void': post: description: >- @@ -65444,6 +68839,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Void a credit note /v1/customer_sessions: post: description: >- @@ -65562,6 +68958,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a Customer Session /v1/customers: get: description: >- @@ -65711,6 +69108,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all customers post: description:

    Creates a new customer object.

    operationId: PostCustomers @@ -65769,7 +69167,7 @@ paths: state: maxLength: 5000 type: string - title: optional_fields_address + title: optional_fields_customer_address type: object - enum: - '' @@ -65945,7 +69343,7 @@ paths: state: maxLength: 5000 type: string - title: optional_fields_address + title: optional_fields_customer_address type: object name: maxLength: 5000 @@ -65982,7 +69380,7 @@ paths: - deferred - immediately type: string - title: tax_param + title: shared_tax_create_param type: object tax_exempt: description: >- @@ -66010,6 +69408,7 @@ paths: - bo_tin - br_cnpj - br_cpf + - by_tin - ca_bn - ca_gst_hst - ca_pst_bc @@ -66045,6 +69444,9 @@ paths: - kr_brn - kz_bin - li_uid + - li_vat + - ma_vat + - md_vat - mx_rfc - my_frp - my_itn @@ -66068,9 +69470,12 @@ paths: - th_vat - tr_tin - tw_vat + - tz_vat - ua_vat - us_ein - uy_ruc + - uz_tin + - uz_vat - ve_rif - vn_tin - za_vat @@ -66104,6 +69509,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a customer /v1/customers/search: get: description: >- @@ -66220,6 +69626,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Search customers '/v1/customers/{customer}': delete: description: >- @@ -66256,6 +69663,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a customer get: description:

    Retrieves a Customer object.

    operationId: GetCustomersCustomer @@ -66302,6 +69710,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a customer post: description: >-

    Updates the specified customer by setting the values of the @@ -66388,7 +69797,7 @@ paths: state: maxLength: 5000 type: string - title: optional_fields_address + title: optional_fields_customer_address type: object - enum: - '' @@ -66691,7 +70100,7 @@ paths: state: maxLength: 5000 type: string - title: optional_fields_address + title: optional_fields_customer_address type: object name: maxLength: 5000 @@ -66725,10 +70134,11 @@ paths: type: string validate_location: enum: + - auto - deferred - immediately type: string - title: tax_param + title: shared_tax_update_param type: object tax_exempt: description: >- @@ -66755,6 +70165,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a customer '/v1/customers/{customer}/balance_transactions': get: description: >- @@ -66868,6 +70279,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List customer balance transactions post: description: >-

    Creates an immutable transaction that updates the customer’s credit @@ -66955,6 +70367,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a customer balance transaction '/v1/customers/{customer}/balance_transactions/{transaction}': get: description: >- @@ -67008,6 +70421,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a customer balance transaction post: description: >-

    Most credit balance transaction fields are immutable, but you may @@ -67084,6 +70498,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a customer credit balance transaction '/v1/customers/{customer}/bank_accounts': get: deprecated: true @@ -67199,6 +70614,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all bank accounts post: description: >-

    When you create a new credit card, you must specify a customer or @@ -67381,6 +70797,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a card '/v1/customers/{customer}/bank_accounts/{id}': delete: description:

    Delete a specified source for a given customer.

    @@ -67432,6 +70849,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a customer source get: deprecated: true description: >- @@ -67487,6 +70905,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a bank account post: description:

    Update a specified source for a given customer.

    operationId: PostCustomersCustomerBankAccountsId @@ -67706,6 +71125,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Verify a bank account '/v1/customers/{customer}/cards': get: deprecated: true @@ -67823,6 +71243,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all cards post: description: >-

    When you create a new credit card, you must specify a customer or @@ -68005,6 +71426,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a card '/v1/customers/{customer}/cards/{id}': delete: description:

    Delete a specified source for a given customer.

    @@ -68056,6 +71478,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a customer source get: deprecated: true description: >- @@ -68111,6 +71534,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a card post: description:

    Update a specified source for a given customer.

    operationId: PostCustomersCustomerCardsId @@ -68315,6 +71739,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a cash balance post: description:

    Changes the settings on a customer’s cash balance.

    operationId: PostCustomersCustomerCashBalance @@ -68371,6 +71796,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a cash balance's settings '/v1/customers/{customer}/cash_balance_transactions': get: description: >- @@ -68494,6 +71920,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List cash balance transactions '/v1/customers/{customer}/cash_balance_transactions/{transaction}': get: description: >- @@ -68548,6 +71975,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a cash balance transaction '/v1/customers/{customer}/discount': delete: description:

    Removes the currently applied discount on a customer.

    @@ -68582,6 +72010,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a customer discount get: description: '' operationId: GetCustomersCustomerDiscount @@ -68731,6 +72160,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create or retrieve funding instructions for a customer cash balance '/v1/customers/{customer}/payment_methods': get: description:

    Returns a list of PaymentMethods for a given Customer

    @@ -68818,6 +72248,7 @@ paths: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -68832,18 +72263,23 @@ paths: - giropay - grabpay - ideal + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -68906,6 +72342,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List a Customer's PaymentMethods '/v1/customers/{customer}/payment_methods/{payment_method}': get: description:

    Retrieves a PaymentMethod object for a given Customer.

    @@ -68958,6 +72395,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Customer's PaymentMethod '/v1/customers/{customer}/sources': get: description:

    List sources for a specified customer.

    @@ -69262,6 +72700,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a card '/v1/customers/{customer}/sources/{id}': delete: description:

    Delete a specified source for a given customer.

    @@ -69313,6 +72752,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a customer source get: description:

    Retrieve a specified source for a given customer.

    operationId: GetCustomersCustomerSourcesId @@ -69583,6 +73023,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Verify a bank account '/v1/customers/{customer}/subscriptions': get: description: >- @@ -69699,6 +73140,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List active subscriptions post: description:

    Creates a new subscription on an existing customer.

    operationId: PostCustomersCustomerSubscriptions @@ -70291,6 +73733,7 @@ paths: - girocard - interac - jcb + - link - mastercard - unionpay - unknown @@ -70423,14 +73866,20 @@ paths: - giropay - grabpay - ideal + - jp_credit_transfer + - kakao_pay - konbini + - kr_card - link - multibanco + - naver_pay - p24 + - payco - paynow - paypal - promptpay - revolut_pay + - sepa_credit_transfer - sepa_debit - sofort - swish @@ -70578,6 +74027,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a subscription '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}': delete: description: >- @@ -70666,6 +74116,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Cancel a subscription get: description:

    Retrieves the subscription with the given ID.

    operationId: GetCustomersCustomerSubscriptionsSubscriptionExposedId @@ -70717,6 +74168,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a subscription post: description: >-

    Updates an existing subscription on a customer to match the specified @@ -71256,7 +74708,7 @@ paths: be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing - collection](/billing/subscriptions/pause-payment). + collection](https://stripe.com/docs/billing/subscriptions/pause-payment). payment_behavior: description: >- Use `allow_incomplete` to transition the subscription to @@ -71375,6 +74827,7 @@ paths: - girocard - interac - jcb + - link - mastercard - unionpay - unknown @@ -71507,14 +74960,20 @@ paths: - giropay - grabpay - ideal + - jp_credit_transfer + - kakao_pay - konbini + - kr_card - link - multibanco + - naver_pay - p24 + - payco - paynow - paypal - promptpay - revolut_pay + - sepa_credit_transfer - sepa_debit - sofort - swish @@ -71672,6 +75131,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a subscription on a customer '/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount': delete: description:

    Removes the currently applied discount on a customer.

    @@ -71713,6 +75173,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a customer discount get: description: '' operationId: GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount @@ -71875,6 +75336,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all Customer tax IDs post: description:

    Creates a new tax_id object for a customer.

    operationId: PostCustomersCustomerTaxIds @@ -71906,18 +75368,19 @@ paths: description: >- Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, - `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, - `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, - `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, - `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, - `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, - `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, - `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, - `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, - `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, - `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, - `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, - `vn_tin`, or `za_vat` + `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, + `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, + `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, + `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, + `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, + `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, + `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, + `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, + `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, + `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, + `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, + `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, + `ve_rif`, `vn_tin`, or `za_vat` enum: - ad_nrt - ae_trn @@ -71929,6 +75392,7 @@ paths: - bo_tin - br_cnpj - br_cpf + - by_tin - ca_bn - ca_gst_hst - ca_pst_bc @@ -71964,6 +75428,9 @@ paths: - kr_brn - kz_bin - li_uid + - li_vat + - ma_vat + - md_vat - mx_rfc - my_frp - my_itn @@ -71987,9 +75454,12 @@ paths: - th_vat - tr_tin - tw_vat + - tz_vat - ua_vat - us_ein - uy_ruc + - uz_tin + - uz_vat - ve_rif - vn_tin - za_vat @@ -72017,6 +75487,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a Customer tax ID '/v1/customers/{customer}/tax_ids/{id}': delete: description:

    Deletes an existing tax_id object.

    @@ -72057,6 +75528,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a Customer tax ID get: description: >-

    Retrieves the tax_id object with the given @@ -72109,6 +75581,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Customer tax ID /v1/disputes: get: description:

    Returns a list of your disputes.

    @@ -72255,6 +75728,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all disputes '/v1/disputes/{dispute}': get: description:

    Retrieves the dispute with the given ID.

    @@ -72300,6 +75774,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a dispute post: description: >-

    When you get a dispute, contacting your customer is always the best @@ -72380,6 +75855,216 @@ paths: duplicate_charge_id: maxLength: 5000 type: string + enhanced_evidence: + anyOf: + - properties: + visa_compelling_evidence_3: + properties: + disputed_transaction: + properties: + customer_account_id: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_device_fingerprint: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_device_id: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_email_address: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_purchase_ip: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + merchandise_or_services: + enum: + - merchandise + - services + type: string + product_description: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + shipping_address: + properties: + city: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + country: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + line1: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + line2: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + postal_code: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + state: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: shipping_address + type: object + title: >- + visa_compelling_evidence3_disputed_transaction + type: object + prior_undisputed_transactions: + items: + properties: + charge: + maxLength: 5000 + type: string + customer_account_id: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_device_fingerprint: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_device_id: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_email_address: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + customer_purchase_ip: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + product_description: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + shipping_address: + properties: + city: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + country: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + line1: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + line2: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + postal_code: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + state: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: shipping_address + type: object + required: + - charge + title: >- + visa_compelling_evidence3_prior_undisputed_transaction + type: object + type: array + title: visa_compelling_evidence3 + type: object + title: enhanced_evidence + type: object + - enum: + - '' + type: string product_description: maxLength: 20000 type: string @@ -72464,6 +76149,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a dispute '/v1/disputes/{dispute}/close': post: description: >- @@ -72515,6 +76201,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Close a dispute /v1/entitlements/active_entitlements: get: description:

    Retrieve a list of active entitlements for a customer

    @@ -72626,6 +76313,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all active entitlements '/v1/entitlements/active_entitlements/{id}': get: description:

    Retrieve an active entitlement

    @@ -72672,6 +76360,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an active entitlement /v1/entitlements/features: get: description:

    Retrieve a list of features

    @@ -72795,6 +76484,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all features post: description:

    Creates a feature

    operationId: PostEntitlementsFeatures @@ -72855,6 +76545,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a feature '/v1/entitlements/features/{id}': get: description:

    Retrieves a feature

    @@ -72901,6 +76592,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a feature post: description:

    Update a feature’s metadata or permanently deactivate it.

    operationId: PostEntitlementsFeaturesId @@ -72969,6 +76661,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Updates a feature /v1/ephemeral_keys: post: description:

    Creates a short-lived API key for a given resource.

    @@ -73029,6 +76722,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create an ephemeral key '/v1/ephemeral_keys/{key}': delete: description:

    Invalidates a short-lived API key for a given resource.

    @@ -73072,6 +76766,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Immediately invalidate an ephemeral key /v1/events: get: description: >- @@ -73236,6 +76931,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all events '/v1/events/{id}': get: description: >- @@ -73284,6 +76980,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an event /v1/exchange_rates: get: description: >- @@ -73392,6 +77089,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all exchange rates '/v1/exchange_rates/{rate_id}': get: description: >- @@ -73439,6 +77137,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an exchange rate /v1/file_links: get: description:

    Returns a list of file links.

    @@ -73579,6 +77278,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all file links post: description:

    Creates a new file link object.

    operationId: PostFileLinks @@ -73610,7 +77310,8 @@ paths: 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`, + `finance_report_run`, `financial_account_statement`, + `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`. @@ -73649,6 +77350,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a file link '/v1/file_links/{link}': get: description:

    Retrieves the file link with the given ID.

    @@ -73693,6 +77395,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a file link post: description: >-

    Updates an existing file link object. Expired links can no longer be @@ -73772,6 +77475,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a file link /v1/files: get: description: >- @@ -73849,6 +77553,7 @@ paths: - dispute_evidence - document_provider_identity_document - finance_report_run + - financial_account_statement - identity_document - identity_document_downloadable - issuing_regulatory_reporting @@ -73927,6 +77632,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all files post: description: >-

    To upload a file to Stripe, you need to send a request of type @@ -74025,6 +77731,7 @@ paths: description: Error response. servers: - url: 'https://files.stripe.com/' + summary: Create a file '/v1/files/{file}': get: description: >- @@ -74074,6 +77781,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a file /v1/financial_connections/accounts: get: description: >- @@ -74210,6 +77918,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List Accounts '/v1/financial_connections/accounts/{account}': get: description: >- @@ -74257,6 +77966,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an Account '/v1/financial_connections/accounts/{account}/disconnect': post: description: >- @@ -74303,6 +78013,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Disconnect an Account '/v1/financial_connections/accounts/{account}/owners': get: description:

    Lists all owners for a given Account

    @@ -74422,6 +78133,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List Account Owners '/v1/financial_connections/accounts/{account}/refresh': post: description: >- @@ -74482,6 +78194,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Refresh Account data '/v1/financial_connections/accounts/{account}/subscribe': post: description: >- @@ -74542,6 +78255,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Subscribe to data refreshes for an Account '/v1/financial_connections/accounts/{account}/unsubscribe': post: description: >- @@ -74602,6 +78316,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Unsubscribe from data refreshes for an Account /v1/financial_connections/sessions: post: description: >- @@ -74730,6 +78445,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a Session '/v1/financial_connections/sessions/{session}': get: description: >- @@ -74777,6 +78493,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Session /v1/financial_connections/transactions: get: description: >- @@ -74932,6 +78649,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List Transactions '/v1/financial_connections/transactions/{transaction}': get: description: >- @@ -74979,6 +78697,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Transaction /v1/forwarding/requests: get: description:

    Lists all ForwardingRequest objects.

    @@ -75096,6 +78815,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all ForwardingRequests post: description:

    Creates a ForwardingRequest object.

    operationId: PostForwardingRequests @@ -75106,6 +78826,9 @@ paths: expand: explode: true style: deepObject + metadata: + explode: true + style: deepObject replacements: explode: true style: deepObject @@ -75121,6 +78844,18 @@ paths: maxLength: 5000 type: string type: array + metadata: + additionalProperties: + type: string + description: >- + Set of [key-value + pairs](https://stripe.com/docs/api/metadata) that you can + attach to an object. This can be useful for storing + additional information about the object in a structured + format. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + type: object payment_method: description: >- The PaymentMethod to insert into the forwarded request. @@ -75187,6 +78922,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a ForwardingRequest '/v1/forwarding/requests/{id}': get: description:

    Retrieves a ForwardingRequest object.

    @@ -75232,6 +78968,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a ForwardingRequest /v1/identity/verification_reports: get: description:

    List all verification reports.

    @@ -75390,6 +79127,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List VerificationReports '/v1/identity/verification_reports/{report}': get: description:

    Retrieves an existing VerificationReport

    @@ -75435,6 +79173,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a VerificationReport /v1/identity/verification_sessions: get: description:

    Returns a list of VerificationSessions

    @@ -75594,6 +79333,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List VerificationSessions post: description: >-

    Creates a VerificationSession object.

    @@ -75716,7 +79456,7 @@ paths: x-stripeBypassValidation: true verification_flow: description: >- - The ID of a Verification Flow from the Dashboard. See + The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows. maxLength: 5000 type: string @@ -75735,6 +79475,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a VerificationSession '/v1/identity/verification_sessions/{session}': get: description: >- @@ -75789,6 +79530,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a VerificationSession post: description: >-

    Updates a VerificationSession object.

    @@ -75907,6 +79649,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a VerificationSession '/v1/identity/verification_sessions/{session}/cancel': post: description: >- @@ -75958,6 +79701,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Cancel a VerificationSession '/v1/identity/verification_sessions/{session}/redact': post: description: >- @@ -76045,6 +79789,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Redact a VerificationSession /v1/invoice_rendering_templates: get: description: >- @@ -76160,6 +79905,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all invoice rendering templates '/v1/invoice_rendering_templates/{template}': get: description: >- @@ -76214,6 +79960,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an invoice rendering template '/v1/invoice_rendering_templates/{template}/archive': post: description: >- @@ -76262,6 +80009,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Archive an invoice rendering template '/v1/invoice_rendering_templates/{template}/unarchive': post: description: >- @@ -76307,6 +80055,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Unarchive an invoice rendering template /v1/invoiceitems: get: description: >- @@ -76467,6 +80216,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all invoice items post: description: >-

    Creates an item to be added to a draft invoice (up to 250 items per @@ -76721,6 +80471,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create an invoice item '/v1/invoiceitems/{invoiceitem}': delete: description: >- @@ -76758,6 +80509,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete an invoice item get: description:

    Retrieves the invoice item with the given ID.

    operationId: GetInvoiceitemsInvoiceitem @@ -76802,6 +80554,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an invoice item post: description: >-

    Updates the amount or description of an invoice item on an upcoming @@ -77036,6 +80789,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update an invoice item /v1/invoices: get: description: >- @@ -77231,6 +80985,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all invoices post: description: >-

    This endpoint creates a draft invoice for a given customer. The @@ -77338,6 +81093,13 @@ paths: - enabled title: automatic_tax_param type: object + automatically_finalizes_at: + description: >- + The time when this invoice should be scheduled to finalize. + The invoice will be finalized at this time if it is still in + draft state. + format: unix-time + type: integer collection_method: description: >- Either `charge_automatically`, or `send_invoice`. When @@ -77750,14 +81512,20 @@ paths: - giropay - grabpay - ideal + - jp_credit_transfer + - kakao_pay - konbini + - kr_card - link - multibanco + - naver_pay - p24 + - payco - paynow - paypal - promptpay - revolut_pay + - sepa_credit_transfer - sepa_debit - sofort - swish @@ -78000,6 +81768,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create an invoice /v1/invoices/create_preview: post: description: >- @@ -78166,7 +81935,7 @@ paths: state: maxLength: 5000 type: string - title: optional_fields_address + title: optional_fields_customer_address type: object name: maxLength: 5000 @@ -78214,6 +81983,7 @@ paths: - bo_tin - br_cnpj - br_cpf + - by_tin - ca_bn - ca_gst_hst - ca_pst_bc @@ -78249,6 +82019,9 @@ paths: - kr_brn - kz_bin - li_uid + - li_vat + - ma_vat + - md_vat - mx_rfc - my_frp - my_itn @@ -78272,9 +82045,12 @@ paths: - th_vat - tr_tin - tw_vat + - tz_vat - ua_vat - us_ein - uy_ruc + - uz_tin + - uz_vat - ve_rif - vn_tin - za_vat @@ -79019,6 +82795,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a preview invoice /v1/invoices/search: get: description: >- @@ -79135,6 +82912,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Search invoices /v1/invoices/upcoming: get: description: >- @@ -79287,7 +83065,7 @@ paths: state: maxLength: 5000 type: string - title: optional_fields_address + title: optional_fields_customer_address type: object name: maxLength: 5000 @@ -79335,6 +83113,7 @@ paths: - bo_tin - br_cnpj - br_cpf + - by_tin - ca_bn - ca_gst_hst - ca_pst_bc @@ -79370,6 +83149,9 @@ paths: - kr_brn - kz_bin - li_uid + - li_vat + - ma_vat + - md_vat - mx_rfc - my_frp - my_itn @@ -79393,9 +83175,12 @@ paths: - th_vat - tr_tin - tw_vat + - tz_vat - ua_vat - us_ein - uy_ruc + - uz_tin + - uz_vat - ve_rif - vn_tin - za_vat @@ -80469,6 +84254,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an upcoming invoice /v1/invoices/upcoming/lines: get: description: >- @@ -80596,7 +84382,7 @@ paths: state: maxLength: 5000 type: string - title: optional_fields_address + title: optional_fields_customer_address type: object name: maxLength: 5000 @@ -80644,6 +84430,7 @@ paths: - bo_tin - br_cnpj - br_cpf + - by_tin - ca_bn - ca_gst_hst - ca_pst_bc @@ -80679,6 +84466,9 @@ paths: - kr_brn - kz_bin - li_uid + - li_vat + - ma_vat + - md_vat - mx_rfc - my_frp - my_itn @@ -80702,9 +84492,12 @@ paths: - th_vat - tr_tin - tw_vat + - tz_vat - ua_vat - us_ein - uy_ruc + - uz_tin + - uz_vat - ve_rif - vn_tin - za_vat @@ -81844,6 +85637,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an upcoming invoice's line items '/v1/invoices/{invoice}': delete: description: >- @@ -81882,6 +85676,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a draft invoice get: description:

    Retrieves the invoice with the given ID.

    operationId: GetInvoicesInvoice @@ -81926,6 +85721,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an invoice post: description: >-

    Draft invoices are fully editable. Once an invoice is - + The time when this invoice should be scheduled to finalize. + The invoice will be finalized at this time if it is still in + draft state. To turn off automatic finalization, set + `auto_advance` to false. + format: unix-time + type: integer collection_method: description: >- Either `charge_automatically` or `send_invoice`. This field @@ -82462,14 +86266,20 @@ paths: - giropay - grabpay - ideal + - jp_credit_transfer + - kakao_pay - konbini + - kr_card - link - multibanco + - naver_pay - p24 + - payco - paynow - paypal - promptpay - revolut_pay + - sepa_credit_transfer - sepa_debit - sofort - swish @@ -82708,6 +86518,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update an invoice '/v1/invoices/{invoice}/add_lines': post: description: >- @@ -82879,7 +86690,7 @@ paths: maxLength: 5000 type: string display_name: - maxLength: 50 + maxLength: 100 type: string inclusive: type: boolean @@ -82902,8 +86713,10 @@ paths: - lease_tax - pst - qst + - retail_delivery_fee - rst - sales_tax + - service_tax - vat type: string x-stripeBypassValidation: true @@ -82954,6 +86767,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Bulk add invoice line items '/v1/invoices/{invoice}/finalize': post: description: >- @@ -83007,6 +86821,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Finalize an invoice '/v1/invoices/{invoice}/lines': get: description: >- @@ -83122,6 +86937,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an invoice's line items '/v1/invoices/{invoice}/lines/{line_item_id}': post: description: >- @@ -83351,7 +87167,7 @@ paths: maxLength: 5000 type: string display_name: - maxLength: 50 + maxLength: 100 type: string inclusive: type: boolean @@ -83374,8 +87190,10 @@ paths: - lease_tax - pst - qst + - retail_delivery_fee - rst - sales_tax + - service_tax - vat type: string x-stripeBypassValidation: true @@ -83437,6 +87255,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update an invoice's line item '/v1/invoices/{invoice}/mark_uncollectible': post: description: >- @@ -83482,6 +87301,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Mark an invoice as uncollectible '/v1/invoices/{invoice}/pay': post: description: >- @@ -83589,6 +87409,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Pay an invoice '/v1/invoices/{invoice}/remove_lines': post: description: >- @@ -83676,6 +87497,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Bulk remove invoice line items '/v1/invoices/{invoice}/send': post: description: >- @@ -83730,6 +87552,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Send an invoice for manual payment '/v1/invoices/{invoice}/update_lines': post: description: >- @@ -83907,7 +87730,7 @@ paths: maxLength: 5000 type: string display_name: - maxLength: 50 + maxLength: 100 type: string inclusive: type: boolean @@ -83930,8 +87753,10 @@ paths: - lease_tax - pst - qst + - retail_delivery_fee - rst - sales_tax + - service_tax - vat type: string x-stripeBypassValidation: true @@ -83984,6 +87809,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Bulk update invoice line items '/v1/invoices/{invoice}/void': post: description: >- @@ -84039,6 +87865,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Void an invoice /v1/issuing/authorizations: get: description: >- @@ -84143,6 +87970,7 @@ paths: - pending - reversed type: string + x-stripeBypassValidation: true style: form requestBody: content: @@ -84197,6 +88025,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all authorizations '/v1/issuing/authorizations/{authorization}': get: description:

    Retrieves an Issuing Authorization object.

    @@ -84242,6 +88071,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an authorization post: description: >-

    Updates the specified Issuing Authorization object by @@ -84306,6 +88136,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update an authorization '/v1/issuing/authorizations/{authorization}/approve': post: deprecated: true @@ -84386,6 +88217,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Approve an authorization '/v1/issuing/authorizations/{authorization}/decline': post: deprecated: true @@ -84457,6 +88289,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Decline an authorization /v1/issuing/cardholders: get: description: >- @@ -84626,6 +88459,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all cardholders post: description: >-

    Creates a new Issuing Cardholder object that can be @@ -85820,6 +89654,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a cardholder '/v1/issuing/cardholders/{cardholder}': get: description:

    Retrieves an Issuing Cardholder object.

    @@ -85865,6 +89700,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a cardholder post: description: >-

    Updates the specified Issuing Cardholder object by @@ -87047,6 +90883,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a cardholder /v1/issuing/cards: get: description: >- @@ -87237,6 +91074,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all cards post: description:

    Creates an Issuing Card object.

    operationId: PostIssuingCards @@ -87329,7 +91167,9 @@ paths: - enum: - '' type: string - description: The second line to print on the card. + description: >- + The second line to print on the card. Max length: 24 + characters. shipping: description: The address where the card will be shipped. properties: @@ -88410,6 +92250,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a card '/v1/issuing/cards/{card}': get: description:

    Retrieves an Issuing Card object.

    @@ -88455,6 +92296,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a card post: description: >-

    Updates the specified Issuing Card object by setting the @@ -89605,6 +93447,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a card /v1/issuing/disputes: get: description: >- @@ -89755,6 +93598,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all disputes post: description: >-

    Creates an Issuing Dispute object. Individual pieces of @@ -90181,6 +94025,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a dispute '/v1/issuing/disputes/{dispute}': get: description:

    Retrieves an Issuing Dispute object.

    @@ -90226,6 +94071,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a dispute post: description: >-

    Updates the specified Issuing Dispute object by setting @@ -90640,6 +94486,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a dispute '/v1/issuing/disputes/{dispute}/submit': post: description: >- @@ -90707,6 +94554,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Submit a dispute /v1/issuing/personalization_designs: get: description: >- @@ -90851,6 +94699,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all personalization designs post: description:

    Creates a personalization design object.

    operationId: PostIssuingPersonalizationDesigns @@ -90983,6 +94832,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a personalization design '/v1/issuing/personalization_designs/{personalization_design}': get: description:

    Retrieves a personalization design object.

    @@ -91028,6 +94878,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a personalization design post: description:

    Updates a card personalization object.

    operationId: PostIssuingPersonalizationDesignsPersonalizationDesign @@ -91193,6 +95044,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a personalization design /v1/issuing/physical_bundles: get: description: >- @@ -91321,6 +95173,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all physical bundles '/v1/issuing/physical_bundles/{physical_bundle}': get: description:

    Retrieves a physical bundle object.

    @@ -91366,6 +95219,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a physical bundle '/v1/issuing/settlements/{settlement}': get: description:

    Retrieves an Issuing Settlement object.

    @@ -91411,6 +95265,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a settlement post: description: >-

    Updates the specified Issuing Settlement object by @@ -91471,6 +95326,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a settlement /v1/issuing/tokens: get: description:

    Lists all Issuing Token objects for a given card.

    @@ -91616,6 +95472,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all issuing tokens for card '/v1/issuing/tokens/{token}': get: description:

    Retrieves an Issuing Token object.

    @@ -91661,6 +95518,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an issuing token post: description: >-

    Attempts to update the specified Issuing Token object to @@ -91714,6 +95572,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a token status /v1/issuing/transactions: get: description: >- @@ -91872,6 +95731,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all transactions '/v1/issuing/transactions/{transaction}': get: description:

    Retrieves an Issuing Transaction object.

    @@ -91917,6 +95777,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a transaction post: description: >-

    Updates the specified Issuing Transaction object by @@ -91981,6 +95842,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a transaction /v1/link_account_sessions: post: description: >- @@ -92109,6 +95971,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a Session '/v1/link_account_sessions/{session}': get: description: >- @@ -92156,6 +96019,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Session /v1/linked_accounts: get: description: >- @@ -92292,6 +96156,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List Accounts '/v1/linked_accounts/{account}': get: description: >- @@ -92339,6 +96204,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an Account '/v1/linked_accounts/{account}/disconnect': post: description: >- @@ -92385,6 +96251,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Disconnect an Account '/v1/linked_accounts/{account}/owners': get: description:

    Lists all owners for a given Account

    @@ -92504,6 +96371,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List Account Owners '/v1/linked_accounts/{account}/refresh': post: description: >- @@ -92564,6 +96432,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Refresh Account data '/v1/mandates/{mandate}': get: description:

    Retrieves a Mandate object.

    @@ -92608,6 +96477,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Mandate /v1/payment_intents: get: description:

    Returns a list of PaymentIntents.

    @@ -92745,6 +96615,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all PaymentIntents post: description: >-

    Creates a PaymentIntent object.

    @@ -93044,8 +96915,9 @@ paths: type: string payment_method_configuration: description: >- - The ID of the payment method configuration to use with this - PaymentIntent. + The ID of the [payment method + configuration](https://stripe.com/docs/api/payment_method_configurations) + to use with this PaymentIntent. maxLength: 100 type: string payment_method_data: @@ -93093,6 +96965,10 @@ paths: - limited - unspecified type: string + alma: + properties: {} + title: param + type: object amazon_pay: properties: {} title: param @@ -93300,6 +97176,10 @@ paths: properties: {} title: param type: object + kakao_pay: + properties: {} + title: param + type: object klarna: properties: dob: @@ -93322,6 +97202,10 @@ paths: properties: {} title: param type: object + kr_card: + properties: {} + title: param + type: object link: properties: {} title: param @@ -93338,6 +97222,16 @@ paths: properties: {} title: param type: object + naver_pay: + properties: + funding: + enum: + - card + - points + type: string + x-stripeBypassValidation: true + title: param + type: object oxxo: properties: {} title: param @@ -93376,6 +97270,10 @@ paths: x-stripeBypassValidation: true title: param type: object + payco: + properties: {} + title: param + type: object paynow: properties: {} title: param @@ -93403,6 +97301,10 @@ paths: properties: {} title: param type: object + samsung_pay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -93441,6 +97343,7 @@ paths: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -93454,18 +97357,23 @@ paths: - giropay - grabpay - ideal + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -93617,6 +97525,19 @@ paths: - enum: - '' type: string + alma: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string amazon_pay: anyOf: - properties: @@ -93818,6 +97739,7 @@ paths: - girocard - interac - jcb + - link - mastercard - unionpay - unknown @@ -94116,6 +98038,25 @@ paths: - enum: - '' type: string + kakao_pay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + setup_future_usage: + enum: + - '' + - none + - off_session + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string klarna: anyOf: - properties: @@ -94223,6 +98164,25 @@ paths: - enum: - '' type: string + kr_card: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + setup_future_usage: + enum: + - '' + - none + - off_session + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string link: anyOf: - properties: @@ -94271,6 +98231,19 @@ paths: - enum: - '' type: string + naver_pay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string oxxo: anyOf: - properties: @@ -94299,6 +98272,19 @@ paths: - enum: - '' type: string + payco: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string paynow: anyOf: - properties: @@ -94409,6 +98395,19 @@ paths: - enum: - '' type: string + samsung_pay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string sepa_debit: anyOf: - properties: @@ -94613,10 +98612,10 @@ paths: payment_method_types: description: >- The list of payment method types (for example, a card) that - this PaymentIntent can use. If you don't provide this, it - defaults to ["card"]. Use `automatic_payment_methods` to - manage payment methods from the [Stripe - Dashboard](https://dashboard.stripe.com/settings/payment_methods). + this PaymentIntent can use. If you don't provide this, + Stripe will dynamically show relevant payment methods from + your [payment method + settings](https://dashboard.stripe.com/settings/payment_methods). items: maxLength: 5000 type: string @@ -94790,6 +98789,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a PaymentIntent /v1/payment_intents/search: get: description: >- @@ -94906,6 +98906,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Search PaymentIntents '/v1/payment_intents/{intent}': get: description: >- @@ -94973,6 +98974,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a PaymentIntent post: description: >-

    Updates properties on a PaymentIntent object without confirming.

    @@ -95138,8 +99140,9 @@ paths: type: string payment_method_configuration: description: >- - The ID of the payment method configuration to use with this - PaymentIntent. + The ID of the [payment method + configuration](https://stripe.com/docs/api/payment_method_configurations) + to use with this PaymentIntent. maxLength: 100 type: string payment_method_data: @@ -95187,6 +99190,10 @@ paths: - limited - unspecified type: string + alma: + properties: {} + title: param + type: object amazon_pay: properties: {} title: param @@ -95394,6 +99401,10 @@ paths: properties: {} title: param type: object + kakao_pay: + properties: {} + title: param + type: object klarna: properties: dob: @@ -95416,6 +99427,10 @@ paths: properties: {} title: param type: object + kr_card: + properties: {} + title: param + type: object link: properties: {} title: param @@ -95432,6 +99447,16 @@ paths: properties: {} title: param type: object + naver_pay: + properties: + funding: + enum: + - card + - points + type: string + x-stripeBypassValidation: true + title: param + type: object oxxo: properties: {} title: param @@ -95470,6 +99495,10 @@ paths: x-stripeBypassValidation: true title: param type: object + payco: + properties: {} + title: param + type: object paynow: properties: {} title: param @@ -95497,6 +99526,10 @@ paths: properties: {} title: param type: object + samsung_pay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -95535,6 +99568,7 @@ paths: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -95548,18 +99582,23 @@ paths: - giropay - grabpay - ideal + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -95711,6 +99750,19 @@ paths: - enum: - '' type: string + alma: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string amazon_pay: anyOf: - properties: @@ -95912,6 +99964,7 @@ paths: - girocard - interac - jcb + - link - mastercard - unionpay - unknown @@ -96210,6 +100263,25 @@ paths: - enum: - '' type: string + kakao_pay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + setup_future_usage: + enum: + - '' + - none + - off_session + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string klarna: anyOf: - properties: @@ -96317,6 +100389,25 @@ paths: - enum: - '' type: string + kr_card: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + setup_future_usage: + enum: + - '' + - none + - off_session + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string link: anyOf: - properties: @@ -96365,6 +100456,19 @@ paths: - enum: - '' type: string + naver_pay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string oxxo: anyOf: - properties: @@ -96393,6 +100497,19 @@ paths: - enum: - '' type: string + payco: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string paynow: anyOf: - properties: @@ -96503,6 +100620,19 @@ paths: - enum: - '' type: string + samsung_pay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string sepa_debit: anyOf: - properties: @@ -96866,6 +100996,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a PaymentIntent '/v1/payment_intents/{intent}/apply_customer_balance': post: description: >- @@ -96893,17 +101024,17 @@ paths: amount: description: >- Amount that you intend to apply to this PaymentIntent from - the customer’s cash balance. + the customer’s cash balance. If the PaymentIntent was + created by an Invoice, the full amount of the PaymentIntent + is applied regardless of this parameter. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, - a zero-decimal currency). - - - The maximum amount is the amount of the PaymentIntent. + a zero-decimal currency). The maximum amount is the amount + of the PaymentIntent. When you omit the amount, it defaults to the remaining @@ -96937,6 +101068,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Reconcile a customer_balance PaymentIntent '/v1/payment_intents/{intent}/cancel': post: description: >- @@ -97010,6 +101142,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Cancel a PaymentIntent '/v1/payment_intents/{intent}/capture': post: description: >- @@ -97149,6 +101282,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Capture a PaymentIntent '/v1/payment_intents/{intent}/confirm': post: description: >- @@ -97435,6 +101569,10 @@ paths: - limited - unspecified type: string + alma: + properties: {} + title: param + type: object amazon_pay: properties: {} title: param @@ -97642,6 +101780,10 @@ paths: properties: {} title: param type: object + kakao_pay: + properties: {} + title: param + type: object klarna: properties: dob: @@ -97664,6 +101806,10 @@ paths: properties: {} title: param type: object + kr_card: + properties: {} + title: param + type: object link: properties: {} title: param @@ -97680,6 +101826,16 @@ paths: properties: {} title: param type: object + naver_pay: + properties: + funding: + enum: + - card + - points + type: string + x-stripeBypassValidation: true + title: param + type: object oxxo: properties: {} title: param @@ -97718,6 +101874,10 @@ paths: x-stripeBypassValidation: true title: param type: object + payco: + properties: {} + title: param + type: object paynow: properties: {} title: param @@ -97745,6 +101905,10 @@ paths: properties: {} title: param type: object + samsung_pay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -97783,6 +101947,7 @@ paths: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -97796,18 +101961,23 @@ paths: - giropay - grabpay - ideal + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -97959,6 +102129,19 @@ paths: - enum: - '' type: string + alma: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string amazon_pay: anyOf: - properties: @@ -98160,6 +102343,7 @@ paths: - girocard - interac - jcb + - link - mastercard - unionpay - unknown @@ -98458,6 +102642,25 @@ paths: - enum: - '' type: string + kakao_pay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + setup_future_usage: + enum: + - '' + - none + - off_session + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string klarna: anyOf: - properties: @@ -98565,6 +102768,25 @@ paths: - enum: - '' type: string + kr_card: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + setup_future_usage: + enum: + - '' + - none + - off_session + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string link: anyOf: - properties: @@ -98613,6 +102835,19 @@ paths: - enum: - '' type: string + naver_pay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string oxxo: anyOf: - properties: @@ -98641,6 +102876,19 @@ paths: - enum: - '' type: string + payco: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string paynow: anyOf: - properties: @@ -98751,6 +102999,19 @@ paths: - enum: - '' type: string + samsung_pay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string sepa_debit: anyOf: - properties: @@ -99099,6 +103360,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Confirm a PaymentIntent '/v1/payment_intents/{intent}/increment_authorization': post: description: >- @@ -99258,6 +103520,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Increment an authorization '/v1/payment_intents/{intent}/verify_microdeposits': post: description:

    Verifies microdeposits on a PaymentIntent object.

    @@ -99321,6 +103584,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Verify microdeposits on a PaymentIntent /v1/payment_links: get: description:

    Returns a list of your payment links.

    @@ -99434,6 +103698,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all payment links post: description:

    Creates a payment link.

    operationId: PostPaymentLinks @@ -99962,6 +104227,7 @@ paths: - affirm - afterpay_clearpay - alipay + - alma - au_becs_debit - bacs_debit - bancontact @@ -100301,6 +104567,7 @@ paths: - book - donate - pay + - subscribe type: string subscription_data: description: >- @@ -100399,6 +104666,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a payment link '/v1/payment_links/{payment_link}': get: description:

    Retrieve a payment link.

    @@ -100444,6 +104712,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve payment link post: description:

    Updates a payment link.

    operationId: PostPaymentLinksPaymentLink @@ -100935,6 +105204,7 @@ paths: - affirm - afterpay_clearpay - alipay + - alma - au_becs_debit - bacs_debit - bancontact @@ -101250,6 +105520,21 @@ paths: description: >- Configuration for collecting the customer's shipping address. + submit_type: + description: >- + Describes the type of transaction being performed in order + to customize relevant text on the page, such as the submit + button. Changing this value will also affect the hostname in + the + [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) + property (example: `donate.stripe.com`). + enum: + - auto + - book + - donate + - pay + - subscribe + type: string subscription_data: description: >- When creating a subscription, the specified configuration @@ -101334,6 +105619,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a payment link '/v1/payment_links/{payment_link}/line_items': get: description: >- @@ -101449,6 +105735,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a payment link's line items /v1/payment_method_configurations: get: description:

    List payment method configurations

    @@ -101566,6 +105853,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List payment method configurations post: description:

    Creates a payment method configuration

    operationId: PostPaymentMethodConfigurations @@ -101585,6 +105873,9 @@ paths: alipay: explode: true style: deepObject + alma: + explode: true + style: deepObject amazon_pay: explode: true style: deepObject @@ -101786,6 +106077,23 @@ paths: type: object title: payment_method_param type: object + alma: + description: >- + Alma is a Buy Now, Pay Later payment method that offers + customers the ability to pay in 2, 3, or 4 installments. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object amazon_pay: description: >- Amazon Pay is a wallet payment method that lets your @@ -102527,8 +106835,8 @@ paths: 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. + [page](https://stripe.com/docs/payments/ach-direct-debit) + for more details. properties: display_preference: properties: @@ -102599,6 +106907,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a payment method configuration '/v1/payment_method_configurations/{configuration}': get: description:

    Retrieve payment method configuration

    @@ -102644,6 +106953,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve payment method configuration post: description:

    Update payment method configuration

    operationId: PostPaymentMethodConfigurationsConfiguration @@ -102671,6 +106981,9 @@ paths: alipay: explode: true style: deepObject + alma: + explode: true + style: deepObject amazon_pay: explode: true style: deepObject @@ -102875,6 +107188,23 @@ paths: type: object title: payment_method_param type: object + alma: + description: >- + Alma is a Buy Now, Pay Later payment method that offers + customers the ability to pay in 2, 3, or 4 installments. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object amazon_pay: description: >- Amazon Pay is a wallet payment method that lets your @@ -103610,8 +107940,8 @@ paths: 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. + [page](https://stripe.com/docs/payments/ach-direct-debit) + for more details. properties: display_preference: properties: @@ -103682,6 +108012,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update payment method configuration /v1/payment_method_domains: get: description:

    Lists the details of existing payment method domains.

    @@ -103803,6 +108134,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List payment method domains post: description:

    Creates a payment method domain.

    operationId: PostPaymentMethodDomains @@ -103851,6 +108183,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a payment method domain '/v1/payment_method_domains/{payment_method_domain}': get: description:

    Retrieves the details of an existing payment method domain.

    @@ -103896,6 +108229,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a payment method domain post: description:

    Updates an existing payment method domain.

    operationId: PostPaymentMethodDomainsPaymentMethodDomain @@ -103944,6 +108278,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a payment method domain '/v1/payment_method_domains/{payment_method_domain}/validate': post: description: >- @@ -104003,6 +108338,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Validate an existing payment method domain /v1/payment_methods: get: description: >- @@ -104079,6 +108415,7 @@ paths: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -104093,18 +108430,23 @@ paths: - giropay - grabpay - ideal + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -104168,6 +108510,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List PaymentMethods post: description: >-

    Creates a PaymentMethod object. Read the - + If this is a Alma PaymentMethod, this hash contains details + about the Alma payment method. + properties: {} + title: param + type: object amazon_pay: description: >- If this is a AmazonPay PaymentMethod, this hash contains @@ -104681,6 +109049,13 @@ paths: properties: {} title: param type: object + kakao_pay: + description: >- + If this is a `kakao_pay` PaymentMethod, this hash contains + details about the Kakao Pay payment method. + properties: {} + title: param + type: object klarna: description: >- If this is a `klarna` PaymentMethod, this hash contains @@ -104709,6 +109084,13 @@ paths: properties: {} title: param type: object + kr_card: + description: >- + If this is a `kr_card` PaymentMethod, this hash contains + details about the Korean Card payment method. + properties: {} + title: param + type: object link: description: >- If this is an `Link` PaymentMethod, this hash contains @@ -104742,6 +109124,19 @@ paths: properties: {} title: param type: object + naver_pay: + description: >- + If this is a `naver_pay` PaymentMethod, this hash contains + details about the Naver Pay payment method. + properties: + funding: + enum: + - card + - points + type: string + x-stripeBypassValidation: true + title: param + type: object oxxo: description: >- If this is an `oxxo` PaymentMethod, this hash contains @@ -104786,6 +109181,13 @@ paths: x-stripeBypassValidation: true title: param type: object + payco: + description: >- + If this is a `payco` PaymentMethod, this hash contains + details about the PAYCO payment method. + properties: {} + title: param + type: object payment_method: description: The PaymentMethod to share. maxLength: 5000 @@ -104836,6 +109238,13 @@ paths: properties: {} title: param type: object + samsung_pay: + description: >- + If this is a `samsung_pay` PaymentMethod, this hash contains + details about the SamsungPay payment method. + properties: {} + title: param + type: object sepa_debit: description: >- If this is a `sepa_debit` PaymentMethod, this hash contains @@ -104891,6 +109300,7 @@ paths: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -104905,18 +109315,23 @@ paths: - giropay - grabpay - ideal + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -104981,6 +109396,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Shares a PaymentMethod '/v1/payment_methods/{payment_method}': get: description: >- @@ -105030,6 +109446,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a PaymentMethod post: description: >-

    Updates a PaymentMethod object. A PaymentMethod must be attached a @@ -105062,6 +109479,9 @@ paths: metadata: explode: true style: deepObject + naver_pay: + explode: true + style: deepObject us_bank_account: explode: true style: deepObject @@ -105186,6 +109606,19 @@ paths: format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + naver_pay: + description: >- + If this is a `naver_pay` PaymentMethod, this hash contains + details about the Naver Pay payment method. + properties: + funding: + enum: + - card + - points + type: string + x-stripeBypassValidation: true + title: param + type: object us_bank_account: description: >- If this is an `us_bank_account` PaymentMethod, this hash @@ -105218,6 +109651,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a PaymentMethod '/v1/payment_methods/{payment_method}/attach': post: description: >- @@ -105298,6 +109732,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Attach a PaymentMethod to a Customer '/v1/payment_methods/{payment_method}/detach': post: description: >- @@ -105344,6 +109779,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Detach a PaymentMethod from a Customer /v1/payouts: get: description: >- @@ -105514,6 +109950,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all payouts post: description: >-

    To send funds to your own bank account, create a new payout object. @@ -105637,6 +110074,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a payout '/v1/payouts/{payout}': get: description: >- @@ -105685,6 +110123,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a payout post: description: >-

    Updates the specified payout by setting the values of the parameters @@ -105749,6 +110188,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a payout '/v1/payouts/{payout}/cancel': post: description: >- @@ -105795,6 +110235,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Cancel a payout '/v1/payouts/{payout}/reverse': post: description: >- @@ -105863,6 +110304,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Reverse a payout /v1/plans: get: description:

    Returns a list of your plans.

    @@ -106008,6 +110450,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all plans post: description: >-

    You can now model subscriptions more flexibly using the - @@ -106315,6 +110759,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a plan get: description:

    Retrieves the plan with the given ID.

    operationId: GetPlansPlan @@ -106359,6 +110804,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a plan post: description: >-

    Updates the specified plan by setting the values of the parameters @@ -106444,6 +110890,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a plan /v1/prices: get: description: >- @@ -106648,6 +111095,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all prices post: description: >-

    Creates a new price for an existing product. The price can be @@ -106994,6 +111442,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a price /v1/prices/search: get: description: >- @@ -107110,6 +111559,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Search prices '/v1/prices/{price}': get: description:

    Retrieves the price with the given ID.

    @@ -107155,6 +111605,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a price post: description: >-

    Updates the specified price by setting the values of the parameters @@ -107320,6 +111771,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a price /v1/products: get: description: >- @@ -107491,6 +111943,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all products post: description:

    Creates a new product object.

    operationId: PostProducts @@ -107588,6 +112041,20 @@ paths: title: currency_option type: object type: object + custom_unit_amount: + properties: + enabled: + type: boolean + maximum: + type: integer + minimum: + type: integer + preset: + type: integer + required: + - enabled + title: custom_unit_amount + type: object recurring: properties: interval: @@ -107744,6 +112211,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a product /v1/products/search: get: description: >- @@ -107860,6 +112328,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Search products '/v1/products/{id}': delete: description: >- @@ -107898,6 +112367,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a product get: description: >-

    Retrieves the details of an existing product. Supply the unique @@ -107945,6 +112415,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a product post: description: >-

    Updates the specific product by setting the values of the parameters @@ -108150,6 +112621,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a product '/v1/products/{product}/features': get: description:

    Retrieve a list of features for a product

    @@ -108260,6 +112732,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all features attached to a product post: description: >-

    Creates a product_feature, which represents a feature attachment to a @@ -108313,6 +112786,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Attach a feature to a product '/v1/products/{product}/features/{id}': delete: description:

    Deletes the feature attachment to a product

    @@ -108354,6 +112828,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Remove a feature from a product get: description: >-

    Retrieves a product_feature, which represents a feature attachment to @@ -108409,6 +112884,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a product_feature /v1/promotion_codes: get: description:

    Returns a list of your promotion codes.

    @@ -108567,6 +113043,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all promotion codes post: description: >-

    A promotion code points to a coupon. You can optionally restrict the @@ -108595,7 +113072,11 @@ paths: description: >- The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific - customer. If left blank, we will generate one automatically. + customer. Valid characters are lower case letters (a-z), + upper case letters (A-Z), and digits (0-9). + + + If left blank, we will generate one automatically. maxLength: 500 type: string coupon: @@ -108676,6 +113157,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a promotion code '/v1/promotion_codes/{promotion_code}': get: description: >- @@ -108725,6 +113207,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a promotion code post: description: >-

    Updates the specified promotion code by setting the values of the @@ -108810,6 +113293,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a promotion code /v1/quotes: get: description:

    Returns a list of your quotes.

    @@ -108946,6 +113430,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all quotes post: description: >-

    A quote models prices and services for a customer. Default options @@ -109373,6 +113858,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a quote '/v1/quotes/{quote}': get: description:

    Retrieves the quote with the given ID.

    @@ -109418,6 +113904,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a quote post: description:

    A quote models prices and services for a customer.

    operationId: PostQuotesQuote @@ -109815,6 +114302,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a quote '/v1/quotes/{quote}/accept': post: description:

    Accepts the specified quote.

    @@ -109858,6 +114346,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Accept a quote '/v1/quotes/{quote}/cancel': post: description:

    Cancels the quote.

    @@ -109901,6 +114390,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Cancel a quote '/v1/quotes/{quote}/computed_upfront_line_items': get: description: >- @@ -110017,6 +114507,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a quote's upfront line items '/v1/quotes/{quote}/finalize': post: description:

    Finalizes the quote.

    @@ -110067,6 +114558,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Finalize a quote '/v1/quotes/{quote}/line_items': get: description: >- @@ -110182,6 +114674,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a quote's line items '/v1/quotes/{quote}/pdf': get: description: >- @@ -110233,6 +114726,7 @@ paths: description: Error response. servers: - url: 'https://files.stripe.com/' + summary: Download quote PDF /v1/radar/early_fraud_warnings: get: description:

    Returns a list of early fraud warnings.

    @@ -110378,6 +114872,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all early fraud warnings '/v1/radar/early_fraud_warnings/{early_fraud_warning}': get: description: >- @@ -110429,6 +114924,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an early fraud warning /v1/radar/value_list_items: get: description: >- @@ -110574,6 +115070,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all value list items post: description: >-

    Creates a new ValueListItem object, which is added to @@ -110625,6 +115122,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a value list item '/v1/radar/value_list_items/{item}': delete: description: >- @@ -110661,6 +115159,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a value list item get: description:

    Retrieves a ValueListItem object.

    operationId: GetRadarValueListItemsItem @@ -110705,6 +115204,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a value list item /v1/radar/value_lists: get: description: >- @@ -110852,6 +115352,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all value lists post: description: >-

    Creates a new ValueList object, which can then be @@ -110935,6 +115436,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a value list '/v1/radar/value_lists/{value_list}': delete: description: >- @@ -110972,6 +115474,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a value list get: description:

    Retrieves a ValueList object.

    operationId: GetRadarValueListsValueList @@ -111016,6 +115519,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a value list post: description: >-

    Updates a ValueList object by setting the values of the @@ -111084,6 +115588,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a value list /v1/refunds: get: description: >- @@ -111226,6 +115731,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all refunds post: description: >-

    When you create a new refund, you must specify a Charge or a @@ -111367,6 +115873,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create customer balance refund '/v1/refunds/{refund}': get: description:

    Retrieves the details of an existing refund.

    @@ -111411,6 +115918,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a refund post: description: >-

    Updates the refund that you specify by setting the values of the @@ -111477,6 +115985,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a refund '/v1/refunds/{refund}/cancel': post: description: >- @@ -111525,6 +116034,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Cancel a refund /v1/reporting/report_runs: get: description: >- @@ -111653,6 +116163,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all Report Runs post: description: >-

    Creates a new object and begin running the report. (Certain report @@ -112373,6 +116884,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a Report Run '/v1/reporting/report_runs/{report_run}': get: description:

    Retrieves the details of an existing Report Run.

    @@ -112418,6 +116930,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Report Run /v1/reporting/report_types: get: description:

    Returns a full list of Report Types.

    @@ -112486,6 +116999,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all Report Types '/v1/reporting/report_types/{report_type}': get: description: >- @@ -112533,6 +117047,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Report Type /v1/reviews: get: description: >- @@ -112662,6 +117177,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all open reviews '/v1/reviews/{review}': get: description:

    Retrieves a Review object.

    @@ -112707,6 +117223,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a review '/v1/reviews/{review}/approve': post: description: >- @@ -112752,6 +117269,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Approve a review /v1/setup_attempts: get: description: >- @@ -112891,6 +117409,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all SetupAttempts /v1/setup_intents: get: description:

    Returns a list of SetupIntents.

    @@ -113053,6 +117572,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all SetupIntents post: description: >-

    Creates a SetupIntent object.

    @@ -113255,8 +117775,9 @@ paths: type: string payment_method_configuration: description: >- - The ID of the payment method configuration to use with this - SetupIntent. + The ID of the [payment method + configuration](https://stripe.com/docs/api/payment_method_configurations) + to use with this SetupIntent. maxLength: 100 type: string payment_method_data: @@ -113302,6 +117823,10 @@ paths: - limited - unspecified type: string + alma: + properties: {} + title: param + type: object amazon_pay: properties: {} title: param @@ -113509,6 +118034,10 @@ paths: properties: {} title: param type: object + kakao_pay: + properties: {} + title: param + type: object klarna: properties: dob: @@ -113531,6 +118060,10 @@ paths: properties: {} title: param type: object + kr_card: + properties: {} + title: param + type: object link: properties: {} title: param @@ -113547,6 +118080,16 @@ paths: properties: {} title: param type: object + naver_pay: + properties: + funding: + enum: + - card + - points + type: string + x-stripeBypassValidation: true + title: param + type: object oxxo: properties: {} title: param @@ -113585,6 +118128,10 @@ paths: x-stripeBypassValidation: true title: param type: object + payco: + properties: {} + title: param + type: object paynow: properties: {} title: param @@ -113612,6 +118159,10 @@ paths: properties: {} title: param type: object + samsung_pay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -113650,6 +118201,7 @@ paths: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -113663,18 +118215,23 @@ paths: - giropay - grabpay - ideal + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -113842,6 +118399,7 @@ paths: - girocard - interac - jcb + - link - mastercard - unionpay - unknown @@ -114020,8 +118578,10 @@ paths: payment_method_types: description: >- The list of payment method types (for example, card) that - this SetupIntent can use. If you don't provide this, it - defaults to ["card"]. + this SetupIntent can use. If you don't provide this, Stripe + will dynamically show relevant payment methods from your + [payment method + settings](https://dashboard.stripe.com/settings/payment_methods). items: maxLength: 5000 type: string @@ -114079,6 +118639,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a SetupIntent '/v1/setup_intents/{intent}': get: description: >- @@ -114146,6 +118707,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a SetupIntent post: description:

    Updates a SetupIntent object.

    operationId: PostSetupIntentsIntent @@ -114260,8 +118822,9 @@ paths: type: string payment_method_configuration: description: >- - The ID of the payment method configuration to use with this - SetupIntent. + The ID of the [payment method + configuration](https://stripe.com/docs/api/payment_method_configurations) + to use with this SetupIntent. maxLength: 100 type: string payment_method_data: @@ -114307,6 +118870,10 @@ paths: - limited - unspecified type: string + alma: + properties: {} + title: param + type: object amazon_pay: properties: {} title: param @@ -114514,6 +119081,10 @@ paths: properties: {} title: param type: object + kakao_pay: + properties: {} + title: param + type: object klarna: properties: dob: @@ -114536,6 +119107,10 @@ paths: properties: {} title: param type: object + kr_card: + properties: {} + title: param + type: object link: properties: {} title: param @@ -114552,6 +119127,16 @@ paths: properties: {} title: param type: object + naver_pay: + properties: + funding: + enum: + - card + - points + type: string + x-stripeBypassValidation: true + title: param + type: object oxxo: properties: {} title: param @@ -114590,6 +119175,10 @@ paths: x-stripeBypassValidation: true title: param type: object + payco: + properties: {} + title: param + type: object paynow: properties: {} title: param @@ -114617,6 +119206,10 @@ paths: properties: {} title: param type: object + samsung_pay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -114655,6 +119248,7 @@ paths: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -114668,18 +119262,23 @@ paths: - giropay - grabpay - ideal + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -114847,6 +119446,7 @@ paths: - girocard - interac - jcb + - link - mastercard - unionpay - unknown @@ -115025,8 +119625,10 @@ paths: payment_method_types: description: >- The list of payment method types (for example, card) that - this SetupIntent can set up. If you don't provide this - array, it defaults to ["card"]. + this SetupIntent can set up. If you don't provide this, + Stripe will dynamically show relevant payment methods from + your [payment method + settings](https://dashboard.stripe.com/settings/payment_methods). items: maxLength: 5000 type: string @@ -115046,6 +119648,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a SetupIntent '/v1/setup_intents/{intent}/cancel': post: description: >- @@ -115109,6 +119712,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Cancel a SetupIntent '/v1/setup_intents/{intent}/confirm': post: description: >- @@ -115306,6 +119910,10 @@ paths: - limited - unspecified type: string + alma: + properties: {} + title: param + type: object amazon_pay: properties: {} title: param @@ -115513,6 +120121,10 @@ paths: properties: {} title: param type: object + kakao_pay: + properties: {} + title: param + type: object klarna: properties: dob: @@ -115535,6 +120147,10 @@ paths: properties: {} title: param type: object + kr_card: + properties: {} + title: param + type: object link: properties: {} title: param @@ -115551,6 +120167,16 @@ paths: properties: {} title: param type: object + naver_pay: + properties: + funding: + enum: + - card + - points + type: string + x-stripeBypassValidation: true + title: param + type: object oxxo: properties: {} title: param @@ -115589,6 +120215,10 @@ paths: x-stripeBypassValidation: true title: param type: object + payco: + properties: {} + title: param + type: object paynow: properties: {} title: param @@ -115616,6 +120246,10 @@ paths: properties: {} title: param type: object + samsung_pay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -115654,6 +120288,7 @@ paths: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -115667,18 +120302,23 @@ paths: - giropay - grabpay - ideal + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -115846,6 +120486,7 @@ paths: - girocard - interac - jcb + - link - mastercard - unionpay - unknown @@ -116053,6 +120694,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Confirm a SetupIntent '/v1/setup_intents/{intent}/verify_microdeposits': post: description:

    Verifies microdeposits on a SetupIntent object.

    @@ -116116,6 +120758,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Verify microdeposits on a SetupIntent /v1/shipping_rates: get: description:

    Returns a list of your shipping rates.

    @@ -116257,6 +120900,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all shipping rates post: description:

    Creates a new shipping rate object.

    operationId: PostShippingRates @@ -116412,6 +121056,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a shipping rate '/v1/shipping_rates/{shipping_rate_token}': get: description:

    Returns the shipping rate object with the given ID.

    @@ -116457,6 +121102,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a shipping rate post: description:

    Updates an existing shipping rate object.

    operationId: PostShippingRatesShippingRateToken @@ -116557,6 +121203,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a shipping rate /v1/sigma/scheduled_query_runs: get: description:

    Returns a list of scheduled query runs.

    @@ -116661,6 +121308,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all scheduled query runs '/v1/sigma/scheduled_query_runs/{scheduled_query_run}': get: description:

    Retrieves the details of an scheduled query run.

    @@ -116706,6 +121354,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a scheduled query run /v1/sources: post: description:

    Creates a new source object.

    @@ -117052,6 +121701,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Shares a source '/v1/sources/{source}': get: description: >- @@ -117110,6 +121760,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a source post: description: >-

    Updates the specified source by setting the values of the parameters @@ -117384,6 +122035,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a source '/v1/sources/{source}/mandate_notifications/{mandate_notification}': get: description:

    Retrieves a new Source MandateNotification.

    @@ -117436,6 +122088,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Source MandateNotification '/v1/sources/{source}/source_transactions': get: description:

    List source transactions for a given source.

    @@ -117602,6 +122255,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a source transaction '/v1/sources/{source}/verify': post: description:

    Verify a given source.

    @@ -117768,6 +122422,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all subscription items post: description: >-

    Adds a new item to an existing subscription. No existing items will @@ -118010,6 +122665,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a subscription item '/v1/subscription_items/{item}': delete: description: >- @@ -118074,6 +122730,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a subscription item get: description:

    Retrieves the subscription item with the given ID.

    operationId: GetSubscriptionItemsItem @@ -118118,6 +122775,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a subscription item post: description: >-

    Updates the plan or quantity of an item on a current @@ -118377,6 +123035,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a subscription item '/v1/subscription_items/{subscription_item}/usage_record_summaries': get: description: >- @@ -118497,6 +123156,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all subscription item period summaries '/v1/subscription_items/{subscription_item}/usage_records': post: description: >- @@ -118603,6 +123263,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a usage record /v1/subscription_schedules: get: description:

    Retrieves the list of your subscription schedules.

    @@ -118810,6 +123471,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all schedules post: description: >-

    Creates a new subscription schedule object. Each customer can have up @@ -119344,6 +124006,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a schedule '/v1/subscription_schedules/{schedule}': get: description: >- @@ -119392,6 +124055,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a schedule post: description:

    Updates an existing subscription schedule.

    operationId: PostSubscriptionSchedulesSchedule @@ -119923,6 +124587,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a schedule '/v1/subscription_schedules/{schedule}/cancel': post: description: >- @@ -119982,6 +124647,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Cancel a schedule '/v1/subscription_schedules/{schedule}/release': post: description: >- @@ -120037,6 +124703,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Release a schedule /v1/subscriptions: get: description: >- @@ -120290,6 +124957,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List subscriptions post: description: >-

    Creates a new subscription on an existing customer. Each customer can @@ -120941,6 +125609,7 @@ paths: - girocard - interac - jcb + - link - mastercard - unionpay - unknown @@ -121073,14 +125742,20 @@ paths: - giropay - grabpay - ideal + - jp_credit_transfer + - kakao_pay - konbini + - kr_card - link - multibanco + - naver_pay - p24 + - payco - paynow - paypal - promptpay - revolut_pay + - sepa_credit_transfer - sepa_debit - sofort - swish @@ -121230,6 +125905,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a subscription /v1/subscriptions/search: get: description: >- @@ -121346,29 +126022,31 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Search subscriptions '/v1/subscriptions/{subscription_exposed_id}': delete: description: >- -

    Cancels a customer’s subscription immediately. The customer will not - be charged again for the subscription.

    +

    Cancels a customer’s subscription immediately. The customer won’t be + charged again for the subscription. After it’s canceled, you can no + longer update the subscription or its metadata.

    -

    Note, however, that any pending invoice items that you’ve created - will still be charged for at the end of the period, unless manually Any pending invoice items that you’ve created are still charged at + the end of the period, unless manually deleted. If you’ve set the subscription - to cancel at the end of the period, any pending prorations will also be - left in place and collected at the end of the period. But if the - subscription is set to cancel immediately, pending prorations will be - removed.

    - - -

    By default, upon subscription cancellation, Stripe will stop - automatic collection of all finalized invoices for the customer. This is - intended to prevent unexpected payment attempts after the customer has - canceled a subscription. However, you can resume automatic collection of - the invoices manually after subscription cancellation to have us - proceed. Or, you could check for unpaid invoices before allowing the - customer to cancel the subscription at all.

    + to cancel at the end of the period, any pending prorations are also left + in place and collected at the end of the period. But if the subscription + is set to cancel immediately, pending prorations are removed.

    + + +

    By default, upon subscription cancellation, Stripe stops automatic + collection of all finalized invoices for the customer. This is intended + to prevent unexpected payment attempts after the customer has canceled a + subscription. However, you can resume automatic collection of the + invoices manually after subscription cancellation to have us proceed. + Or, you could check for unpaid invoices before allowing the customer to + cancel the subscription at all.

    operationId: DeleteSubscriptionsSubscriptionExposedId parameters: - in: path @@ -121425,7 +126103,7 @@ paths: description: >- Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice - items. Defaults to `true`. + items. Defaults to `false`. type: boolean prorate: description: >- @@ -121448,6 +126126,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Cancel a subscription get: description:

    Retrieves the subscription with the given ID.

    operationId: GetSubscriptionsSubscriptionExposedId @@ -121492,6 +126171,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a subscription post: description: >-

    Updates an existing subscription to match the specified parameters. @@ -121534,7 +126214,7 @@ paths:

    In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how Stripe + href="/docs/billing/subscriptions/upgrade-downgrade#immediate-payment">Stripe immediately attempts payment for subscription changes.

    @@ -122116,7 +126796,7 @@ paths: be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing - collection](/billing/subscriptions/pause-payment). + collection](https://stripe.com/docs/billing/subscriptions/pause-payment). payment_behavior: description: >- Use `allow_incomplete` to transition the subscription to @@ -122235,6 +126915,7 @@ paths: - girocard - interac - jcb + - link - mastercard - unionpay - unknown @@ -122367,14 +127048,20 @@ paths: - giropay - grabpay - ideal + - jp_credit_transfer + - kakao_pay - konbini + - kr_card - link - multibanco + - naver_pay - p24 + - payco - paynow - paypal - promptpay - revolut_pay + - sepa_credit_transfer - sepa_debit - sofort - swish @@ -122532,6 +127219,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a subscription '/v1/subscriptions/{subscription_exposed_id}/discount': delete: description:

    Removes the currently applied discount on a subscription.

    @@ -122566,6 +127254,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a subscription discount '/v1/subscriptions/{subscription}/resume': post: description: >- @@ -122597,17 +127286,13 @@ paths: properties: billing_cycle_anchor: description: >- - Either `now` or `unchanged`. Setting the value to `now` - resets the subscription's billing cycle anchor to the - current time (in UTC). Setting the value to `unchanged` - advances the subscription's billing cycle anchor to the - period that surrounds the current time. For more - information, see the billing cycle + The billing cycle anchor that applies when the subscription + is resumed. Either `now` or `unchanged`. The default is + `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). enum: - now - unchanged - maxLength: 5000 type: string expand: description: Specifies which fields in the response should be expanded. @@ -122653,6 +127338,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Resume a subscription /v1/tax/calculations: post: description: >- @@ -122764,6 +127450,7 @@ paths: - bo_tin - br_cnpj - br_cpf + - by_tin - ca_bn - ca_gst_hst - ca_pst_bc @@ -122799,6 +127486,9 @@ paths: - kr_brn - kz_bin - li_uid + - li_vat + - ma_vat + - md_vat - mx_rfc - my_frp - my_itn @@ -122822,9 +127512,12 @@ paths: - th_vat - tr_tin - tw_vat + - tz_vat - ua_vat - us_ein - uy_ruc + - uz_tin + - uz_vat - ve_rif - vn_tin - za_vat @@ -122974,6 +127667,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a Tax Calculation '/v1/tax/calculations/{calculation}': get: description: >- @@ -123021,6 +127715,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Tax Calculation '/v1/tax/calculations/{calculation}/line_items': get: description: >- @@ -123135,6 +127830,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a calculation's line items /v1/tax/registrations: get: description:

    Returns a list of Tax Registration objects.

    @@ -123251,6 +127947,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List registrations post: description:

    Creates a new Tax Registration object.

    operationId: PostTaxRegistrations @@ -123361,39 +128058,49 @@ paths: - type title: europe type: object - bg: + bg: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + bh: properties: - standard: - properties: - place_of_supply_scheme: - enum: - - small_seller - - standard - type: string - required: - - place_of_supply_scheme - title: standard - type: object type: enum: - - ioss - - oss_non_union - - oss_union - standard type: string required: - type - title: europe + title: default type: object - bh: + by: properties: type: enum: - - standard + - simplified type: string required: - type - title: default + title: simplified type: object ca: properties: @@ -123446,6 +128153,16 @@ paths: - type title: simplified type: object + cr: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object cy: properties: standard: @@ -123542,6 +128259,16 @@ paths: - type title: europe type: object + ec: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object ee: properties: standard: @@ -123920,6 +128647,26 @@ paths: - type title: europe type: object + ma: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + md: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object mt: properties: standard: @@ -124100,6 +128847,26 @@ paths: - type title: europe type: object + rs: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + ru: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object sa: properties: type: @@ -124212,6 +128979,16 @@ paths: - type title: simplified type: object + tz: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object us: properties: local_amusement_tax: @@ -124263,6 +129040,7 @@ paths: - local_amusement_tax - local_lease_tax - state_communications_tax + - state_retail_delivery_fee - state_sales_tax type: string x-stripeBypassValidation: true @@ -124271,6 +129049,16 @@ paths: - type title: united_states type: object + uz: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object vn: properties: type: @@ -124326,6 +129114,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a registration '/v1/tax/registrations/{id}': get: description:

    Returns a Tax Registration object.

    @@ -124371,6 +129160,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a registration post: description: >-

    Updates an existing Tax Registration object.

    @@ -124453,6 +129243,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a registration /v1/tax/settings: get: description:

    Retrieves Tax Settings for a merchant.

    @@ -124491,6 +129282,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve settings post: description: >-

    Updates Tax Settings parameters used in tax @@ -124576,6 +129368,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update settings /v1/tax/transactions/create_from_calculation: post: description: >- @@ -124653,6 +129446,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a transaction from a calculation /v1/tax/transactions/create_reversal: post: description: >- @@ -124785,6 +129579,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a reversal transaction '/v1/tax/transactions/{transaction}': get: description:

    Retrieves a Tax Transaction object.

    @@ -124830,6 +129625,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a transaction '/v1/tax/transactions/{transaction}/line_items': get: description: >- @@ -124944,6 +129740,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a transaction's line items /v1/tax_codes: get: description: >- @@ -125048,6 +129845,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all tax codes '/v1/tax_codes/{id}': get: description: >- @@ -125096,6 +129894,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a tax code /v1/tax_ids: get: description:

    Returns a list of tax IDs.

    @@ -125226,6 +130025,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all tax IDs post: description:

    Creates a new account or customer tax_id object.

    operationId: PostTaxIds @@ -125273,18 +130073,19 @@ paths: description: >- Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, - `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, - `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, - `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, - `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, - `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, - `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, - `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, - `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, - `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, - `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, - `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, - `vn_tin`, or `za_vat` + `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, + `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, + `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, + `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, + `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, + `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, + `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, + `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, + `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, + `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, + `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, + `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, + `ve_rif`, `vn_tin`, or `za_vat` enum: - ad_nrt - ae_trn @@ -125296,6 +130097,7 @@ paths: - bo_tin - br_cnpj - br_cpf + - by_tin - ca_bn - ca_gst_hst - ca_pst_bc @@ -125331,6 +130133,9 @@ paths: - kr_brn - kz_bin - li_uid + - li_vat + - ma_vat + - md_vat - mx_rfc - my_frp - my_itn @@ -125354,9 +130159,12 @@ paths: - th_vat - tr_tin - tw_vat + - tz_vat - ua_vat - us_ein - uy_ruc + - uz_tin + - uz_vat - ve_rif - vn_tin - za_vat @@ -125384,6 +130192,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a tax ID '/v1/tax_ids/{id}': delete: description: >- @@ -125420,6 +130229,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a tax ID get: description:

    Retrieves an account or customer tax_id object.

    operationId: GetTaxIdsId @@ -125464,6 +130274,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a tax ID /v1/tax_rates: get: description: >- @@ -125609,6 +130420,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all tax rates post: description:

    Creates a new tax rate.

    operationId: PostTaxRates @@ -125701,8 +130513,10 @@ paths: - lease_tax - pst - qst + - retail_delivery_fee - rst - sales_tax + - service_tax - vat type: string x-stripeBypassValidation: true @@ -125725,6 +130539,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a tax rate '/v1/tax_rates/{tax_rate}': get: description:

    Retrieves a tax rate with the given ID

    @@ -125770,6 +130585,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a tax rate post: description:

    Updates an existing tax rate.

    operationId: PostTaxRatesTaxRate @@ -125868,8 +130684,10 @@ paths: - lease_tax - pst - qst + - retail_delivery_fee - rst - sales_tax + - service_tax - vat type: string x-stripeBypassValidation: true @@ -125888,6 +130706,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a tax rate /v1/terminal/configurations: get: description:

    Returns a list of Configuration objects.

    @@ -126001,6 +130820,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all Configurations post: description:

    Creates a new Configuration object.

    operationId: PostTerminalConfigurations @@ -126252,6 +131072,20 @@ paths: type: integer title: currency_specific_config type: object + pln: + properties: + fixed_amounts: + items: + type: integer + type: array + percentages: + items: + type: integer + type: array + smart_tip_threshold: + type: integer + title: currency_specific_config + type: object sek: properties: fixed_amounts: @@ -126328,6 +131162,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a Configuration '/v1/terminal/configurations/{configuration}': delete: description:

    Deletes a Configuration object.

    @@ -126362,6 +131197,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a Configuration get: description:

    Retrieves a Configuration object.

    operationId: GetTerminalConfigurationsConfiguration @@ -126408,6 +131244,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Configuration post: description:

    Updates a new Configuration object.

    operationId: PostTerminalConfigurationsConfiguration @@ -126679,6 +131516,20 @@ paths: type: integer title: currency_specific_config type: object + pln: + properties: + fixed_amounts: + items: + type: integer + type: array + percentages: + items: + type: integer + type: array + smart_tip_threshold: + type: integer + title: currency_specific_config + type: object sek: properties: fixed_amounts: @@ -126761,6 +131612,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a Configuration /v1/terminal/connection_tokens: post: description: >- @@ -126811,6 +131663,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a Connection Token /v1/terminal/locations: get: description:

    Returns a list of Location objects.

    @@ -126915,6 +131768,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all Locations post: description: >-

    Creates a new Location object. @@ -127014,6 +131868,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a Location '/v1/terminal/locations/{location}': delete: description:

    Deletes a Location object.

    @@ -127048,6 +131903,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a Location get: description:

    Retrieves a Location object.

    operationId: GetTerminalLocationsLocation @@ -127094,6 +131950,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Location post: description: >-

    Updates a Location object by setting the values of the @@ -127208,6 +132065,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a Location /v1/terminal/readers: get: description:

    Returns a list of Reader objects.

    @@ -127357,6 +132215,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all Readers post: description:

    Creates a new Reader object.

    operationId: PostTerminalReaders @@ -127429,6 +132288,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a Reader '/v1/terminal/readers/{reader}': delete: description:

    Deletes a Reader object.

    @@ -127463,6 +132323,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a Reader get: description:

    Retrieves a Reader object.

    operationId: GetTerminalReadersReader @@ -127509,6 +132370,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Reader post: description: >-

    Updates a Reader object by setting the values of the @@ -127586,6 +132448,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a Reader '/v1/terminal/readers/{reader}/cancel_action': post: description:

    Cancels the current reader action.

    @@ -127629,6 +132492,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Cancel the current reader action '/v1/terminal/readers/{reader}/process_payment_intent': post: description:

    Initiates a payment flow on a Reader.

    @@ -127667,6 +132531,12 @@ paths: process_config: description: Configuration overrides properties: + allow_redisplay: + enum: + - always + - limited + - unspecified + type: string enable_customer_cancellation: type: boolean skip_tipping: @@ -127696,6 +132566,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Hand-off a PaymentIntent to a Reader '/v1/terminal/readers/{reader}/process_setup_intent': post: description:

    Initiates a setup intent flow on a Reader.

    @@ -127721,9 +132592,18 @@ paths: schema: additionalProperties: false properties: - customer_consent_collected: - description: Customer Consent Collected - type: boolean + allow_redisplay: + description: >- + This field indicates whether this payment method can be + shown again to its customer in a checkout flow. Stripe + products such as Checkout and Elements use this field to + determine whether a payment method can be shown as a saved + payment method in a checkout flow. + enum: + - always + - limited + - unspecified + type: string expand: description: Specifies which fields in the response should be expanded. items: @@ -127742,6 +132622,7 @@ paths: maxLength: 5000 type: string required: + - allow_redisplay - setup_intent type: object required: true @@ -127758,6 +132639,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Hand-off a SetupIntent to a Reader '/v1/terminal/readers/{reader}/refund_payment': post: description:

    Initiates a refund on a Reader

    @@ -127857,6 +132739,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Refund a Charge or a PaymentIntent in-person '/v1/terminal/readers/{reader}/set_reader_display': post: description:

    Sets reader display to show cart details.

    @@ -127942,6 +132825,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Set reader display /v1/test_helpers/confirmation_tokens: post: description: >- @@ -128014,6 +132898,10 @@ paths: - limited - unspecified type: string + alma: + properties: {} + title: param + type: object amazon_pay: properties: {} title: param @@ -128221,6 +133109,10 @@ paths: properties: {} title: param type: object + kakao_pay: + properties: {} + title: param + type: object klarna: properties: dob: @@ -128243,6 +133135,10 @@ paths: properties: {} title: param type: object + kr_card: + properties: {} + title: param + type: object link: properties: {} title: param @@ -128259,6 +133155,16 @@ paths: properties: {} title: param type: object + naver_pay: + properties: + funding: + enum: + - card + - points + type: string + x-stripeBypassValidation: true + title: param + type: object oxxo: properties: {} title: param @@ -128297,6 +133203,10 @@ paths: x-stripeBypassValidation: true title: param type: object + payco: + properties: {} + title: param + type: object paynow: properties: {} title: param @@ -128324,6 +133234,10 @@ paths: properties: {} title: param type: object + samsung_pay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -128362,6 +133276,7 @@ paths: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit @@ -128375,18 +133290,23 @@ paths: - giropay - grabpay - ideal + - kakao_pay - klarna - konbini + - kr_card - link - mobilepay - multibanco + - naver_pay - oxxo - p24 + - payco - paynow - paypal - pix - promptpay - revolut_pay + - samsung_pay - sepa_debit - sofort - swish @@ -128504,6 +133424,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a test Confirmation Token '/v1/test_helpers/customers/{customer}/fund_cash_balance': post: description:

    Create an incoming testmode bank transfer

    @@ -128576,6 +133497,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Fund a test mode cash balance /v1/test_helpers/issuing/authorizations: post: description:

    Create a test-mode authorization.

    @@ -128764,6 +133686,21 @@ paths: [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. type: boolean + merchant_amount: + description: >- + The total amount to attempt to authorize. This amount is in + the provided merchant currency, and in the [smallest + currency + unit](https://stripe.com/docs/currencies#zero-decimal). + type: integer + merchant_currency: + description: >- + The currency of the authorization. If not provided, defaults + to the currency of the card. Three-letter [ISO currency + code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a [supported + currency](https://stripe.com/docs/currencies). + type: string merchant_data: description: >- Details about the seller (grocery store, e-commerce website, @@ -129185,7 +134122,6 @@ paths: - samsung_pay type: string required: - - amount - card type: object required: true @@ -129202,6 +134138,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a test-mode authorization '/v1/test_helpers/issuing/authorizations/{authorization}/capture': post: description:

    Capture a test-mode authorization.

    @@ -129432,6 +134369,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Capture a test-mode authorization '/v1/test_helpers/issuing/authorizations/{authorization}/expire': post: description:

    Expire a test-mode Authorization.

    @@ -129475,6 +134413,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Expire a test-mode authorization '/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount': post: description: >- @@ -129639,6 +134578,62 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Finalize a test-mode authorization's amount + '/v1/test_helpers/issuing/authorizations/{authorization}/fraud_challenges/respond': + post: + description: >- +

    Respond to a fraud challenge on a testmode Issuing authorization, + simulating either a confirmation of fraud or a correction of + legitimacy.

    + operationId: PostTestHelpersIssuingAuthorizationsAuthorizationFraudChallengesRespond + parameters: + - in: path + name: authorization + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + confirmed: + description: >- + Whether to simulate the user confirming that the transaction + was legitimate (true) or telling Stripe that it was + fraudulent (false). + type: boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + required: + - confirmed + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.authorization' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Respond to fraud challenge '/v1/test_helpers/issuing/authorizations/{authorization}/increment': post: description:

    Increment a test-mode Authorization.

    @@ -129696,6 +134691,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Increment a test-mode authorization '/v1/test_helpers/issuing/authorizations/{authorization}/reverse': post: description:

    Reverse a test-mode Authorization.

    @@ -129747,6 +134743,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Reverse a test-mode authorization '/v1/test_helpers/issuing/cards/{card}/shipping/deliver': post: description: >- @@ -129792,6 +134789,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Deliver a testmode card '/v1/test_helpers/issuing/cards/{card}/shipping/fail': post: description: >- @@ -129837,6 +134835,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Fail a testmode card '/v1/test_helpers/issuing/cards/{card}/shipping/return': post: description: >- @@ -129882,6 +134881,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Return a testmode card '/v1/test_helpers/issuing/cards/{card}/shipping/ship': post: description: >- @@ -129927,6 +134927,54 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Ship a testmode card + '/v1/test_helpers/issuing/cards/{card}/shipping/submit': + post: + description: >- +

    Updates the shipping status of the specified Issuing + Card object to submitted. This method requires + Stripe Version ‘2024-09-30.acacia’ or later.

    + operationId: PostTestHelpersIssuingCardsCardShippingSubmit + parameters: + - in: path + name: card + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.card' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Submit a testmode card '/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate': post: description: >- @@ -129973,6 +135021,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Activate a testmode personalization design '/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate': post: description: >- @@ -130019,6 +135068,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Deactivate a testmode personalization design '/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject': post: description: >- @@ -130099,6 +135149,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Reject a testmode personalization design /v1/test_helpers/issuing/settlements: post: description:

    Allows the user to create an Issuing settlement.

    @@ -130179,6 +135230,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a test-mode settleemnt /v1/test_helpers/issuing/transactions/create_force_capture: post: description: >- @@ -130751,6 +135803,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a test-mode force capture /v1/test_helpers/issuing/transactions/create_unlinked_refund: post: description: >- @@ -131324,6 +136377,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a test-mode unlinked refund '/v1/test_helpers/issuing/transactions/{transaction}/refund': post: description:

    Refund a test-mode Transaction.

    @@ -131374,6 +136428,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Refund a test-mode transaction '/v1/test_helpers/refunds/{refund}/expire': post: description:

    Expire a refund with a status of requires_action.

    @@ -131416,6 +136471,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Expire a pending refund. '/v1/test_helpers/terminal/readers/{reader}/present_payment_method': post: description: >- @@ -131494,6 +136550,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Simulate presenting a payment method /v1/test_helpers/test_clocks: get: description:

    Returns a list of your test clocks.

    @@ -131598,6 +136655,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all test clocks post: description: >-

    Creates a new test clock that can be attached to new customers and @@ -131644,6 +136702,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a test clock '/v1/test_helpers/test_clocks/{test_clock}': delete: description:

    Deletes a test clock.

    @@ -131678,6 +136737,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a test clock get: description:

    Retrieves a test clock.

    operationId: GetTestHelpersTestClocksTestClock @@ -131722,6 +136782,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a test clock '/v1/test_helpers/test_clocks/{test_clock}/advance': post: description: >- @@ -131778,6 +136839,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Advance a test clock '/v1/test_helpers/treasury/inbound_transfers/{id}/fail': post: description: >- @@ -131831,7 +136893,7 @@ paths: - no_account - other type: string - title: failure_details_params + title: failure_details_param type: object type: object required: false @@ -131848,6 +136910,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: 'Test mode: Fail an InboundTransfer' '/v1/test_helpers/treasury/inbound_transfers/{id}/return': post: description: >- @@ -131894,6 +136957,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: 'Test mode: Return an InboundTransfer' '/v1/test_helpers/treasury/inbound_transfers/{id}/succeed': post: description: >- @@ -131940,6 +137004,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: 'Test mode: Succeed an InboundTransfer' '/v1/test_helpers/treasury/outbound_payments/{id}': post: description: >- @@ -132025,6 +137090,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: 'Test mode: Update an OutboundPayment' '/v1/test_helpers/treasury/outbound_payments/{id}/fail': post: description: >- @@ -132071,6 +137137,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: 'Test mode: Fail an OutboundPayment' '/v1/test_helpers/treasury/outbound_payments/{id}/post': post: description: >- @@ -132117,6 +137184,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: 'Test mode: Post an OutboundPayment' '/v1/test_helpers/treasury/outbound_payments/{id}/return': post: description: >- @@ -132184,6 +137252,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: 'Test mode: Return an OutboundPayment' '/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}': post: description: >- @@ -132269,6 +137338,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: 'Test mode: Update an OutboundTransfer' '/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail': post: description: >- @@ -132315,6 +137385,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: 'Test mode: Fail an OutboundTransfer' '/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post': post: description: >- @@ -132361,6 +137432,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: 'Test mode: Post an OutboundTransfer' '/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return': post: description: >- @@ -132428,6 +137500,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: 'Test mode: Return an OutboundTransfer' /v1/test_helpers/treasury/received_credits: post: description: >- @@ -132528,6 +137601,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: 'Test mode: Create a ReceivedCredit' /v1/test_helpers/treasury/received_debits: post: description: >- @@ -132627,12 +137701,13 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: 'Test mode: Create a ReceivedDebit' /v1/tokens: post: description: >-

    Creates a single-use token that represents a bank account’s details. - You can use this token with any API method in place of a bank account + You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a connected account where controller.requirement_collection @@ -133506,6 +138581,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a CVC update token '/v1/tokens/{token}': get: description:

    Retrieves the token with the given ID.

    @@ -133551,6 +138627,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a token /v1/topups: get: description:

    Returns a list of top-ups.

    @@ -133713,6 +138790,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all top-ups post: description:

    Top up the balance of an account

    operationId: PostTopups @@ -133804,6 +138882,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a top-up '/v1/topups/{topup}': get: description: >- @@ -133853,6 +138932,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a top-up post: description: >-

    Updates the metadata of a top-up. Other top-up details are not @@ -133922,6 +139002,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a top-up '/v1/topups/{topup}/cancel': post: description:

    Cancels a top-up. Only pending top-ups can be canceled.

    @@ -133965,6 +139046,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Cancel a top-up /v1/transfers: get: description: >- @@ -134113,6 +139195,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all transfers post: description: >-

    To send funds from your Stripe account to a connected account, you @@ -134222,6 +139305,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a transfer '/v1/transfers/{id}/reversals': get: description: >- @@ -134338,6 +139422,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all reversals post: description: >-

    When you create a new reversal, you must specify a transfer to create @@ -134435,6 +139520,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a transfer reversal '/v1/transfers/{transfer}': get: description: >- @@ -134483,6 +139569,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a transfer post: description: >-

    Updates the specified transfer by setting the values of the @@ -134556,6 +139643,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a transfer '/v1/transfers/{transfer}/reversals/{id}': get: description: >- @@ -134611,6 +139699,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a reversal post: description: >-

    Updates the specified reversal by setting the values of the @@ -134685,6 +139774,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a reversal /v1/treasury/credit_reversals: get: description:

    Returns a list of CreditReversals.

    @@ -134815,6 +139905,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all CreditReversals post: description:

    Reverses a ReceivedCredit and creates a CreditReversal object.

    operationId: PostTreasuryCreditReversals @@ -134870,6 +139961,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a CreditReversal '/v1/treasury/credit_reversals/{credit_reversal}': get: description: >- @@ -134918,6 +140010,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a CreditReversal /v1/treasury/debit_reversals: get: description:

    Returns a list of DebitReversals.

    @@ -135058,6 +140151,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all DebitReversals post: description:

    Reverses a ReceivedDebit and creates a DebitReversal object.

    operationId: PostTreasuryDebitReversals @@ -135113,6 +140207,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a DebitReversal '/v1/treasury/debit_reversals/{debit_reversal}': get: description:

    Retrieves a DebitReversal object.

    @@ -135158,6 +140253,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a DebitReversal /v1/treasury/financial_accounts: get: description:

    Returns a list of FinancialAccounts.

    @@ -135272,6 +140368,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all FinancialAccounts post: description: >-

    Creates a new FinancialAccount. For now, each connected account can @@ -135453,6 +140550,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a FinancialAccount '/v1/treasury/financial_accounts/{financial_account}': get: description:

    Retrieves the details of a FinancialAccount.

    @@ -135498,6 +140596,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a FinancialAccount post: description:

    Updates the details of a FinancialAccount.

    operationId: PostTreasuryFinancialAccountsFinancialAccount @@ -135675,6 +140774,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a FinancialAccount '/v1/treasury/financial_accounts/{financial_account}/features': get: description: >- @@ -135722,6 +140822,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve FinancialAccount Features post: description:

    Updates the Features associated with a FinancialAccount.

    operationId: PostTreasuryFinancialAccountsFinancialAccountFeatures @@ -135898,6 +140999,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update FinancialAccount Features /v1/treasury/inbound_transfers: get: description: >- @@ -135971,6 +141073,7 @@ paths: - processing - succeeded type: string + x-stripeBypassValidation: true style: form requestBody: content: @@ -136025,6 +141128,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all InboundTransfers post: description:

    Creates an InboundTransfer.

    operationId: PostTreasuryInboundTransfers @@ -136110,6 +141214,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create an InboundTransfer '/v1/treasury/inbound_transfers/{id}': get: description:

    Retrieves the details of an existing InboundTransfer.

    @@ -136155,6 +141260,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an InboundTransfer '/v1/treasury/inbound_transfers/{inbound_transfer}/cancel': post: description:

    Cancels an InboundTransfer.

    @@ -136198,6 +141304,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Cancel an InboundTransfer /v1/treasury/outbound_payments: get: description: >- @@ -136357,6 +141464,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all OutboundPayments post: description:

    Creates an OutboundPayment.

    operationId: PostTreasuryOutboundPayments @@ -136587,6 +141695,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create an OutboundPayment '/v1/treasury/outbound_payments/{id}': get: description: >- @@ -136635,6 +141744,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an OutboundPayment '/v1/treasury/outbound_payments/{id}/cancel': post: description:

    Cancel an OutboundPayment.

    @@ -136678,6 +141788,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Cancel an OutboundPayment /v1/treasury/outbound_transfers: get: description: >- @@ -136806,6 +141917,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all OutboundTransfers post: description:

    Creates an OutboundTransfer.

    operationId: PostTreasuryOutboundTransfers @@ -136913,6 +142025,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create an OutboundTransfer '/v1/treasury/outbound_transfers/{outbound_transfer}': get: description: >- @@ -136961,6 +142074,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve an OutboundTransfer '/v1/treasury/outbound_transfers/{outbound_transfer}/cancel': post: description: >- @@ -137006,6 +142120,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Cancel an OutboundTransfer /v1/treasury/received_credits: get: description:

    Returns a list of ReceivedCredits.

    @@ -137150,6 +142265,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all ReceivedCredits '/v1/treasury/received_credits/{id}': get: description: >- @@ -137197,6 +142313,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a ReceivedCredit /v1/treasury/received_debits: get: description:

    Returns a list of ReceivedDebits.

    @@ -137321,6 +142438,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all ReceivedDebits '/v1/treasury/received_debits/{id}': get: description: >- @@ -137368,6 +142486,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a ReceivedDebit /v1/treasury/transaction_entries: get: description:

    Retrieves a list of TransactionEntry objects.

    @@ -137541,6 +142660,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all TransactionEntries '/v1/treasury/transaction_entries/{id}': get: description:

    Retrieves a TransactionEntry object.

    @@ -137586,6 +142706,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a TransactionEntry /v1/treasury/transactions: get: description:

    Retrieves a list of Transaction objects.

    @@ -137772,6 +142893,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all Transactions '/v1/treasury/transactions/{id}': get: description:

    Retrieves the details of an existing Transaction.

    @@ -137817,6 +142939,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a Transaction /v1/webhook_endpoints: get: description:

    Returns a list of your webhook endpoints.

    @@ -137921,6 +143044,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: List all webhook endpoints post: description: >-

    A webhook endpoint must have a url and a list of @@ -138060,6 +143184,8 @@ paths: - '2023-10-16' - '2024-04-10' - '2024-06-20' + - 2024-09-30.acacia + - 2024-10-28.acacia maxLength: 5000 type: string x-stripeBypassValidation: true @@ -138205,6 +143331,7 @@ paths: - issuing_token.created - issuing_token.updated - issuing_transaction.created + - issuing_transaction.purchase_details_receipt_updated - issuing_transaction.updated - mandate.updated - payment_intent.amount_capturable_updated @@ -138248,6 +143375,7 @@ paths: - radar.early_fraud_warning.created - radar.early_fraud_warning.updated - refund.created + - refund.failed - refund.updated - reporting.report_run.failed - reporting.report_run.succeeded @@ -138368,6 +143496,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Create a webhook endpoint '/v1/webhook_endpoints/{webhook_endpoint}': delete: description: >- @@ -138405,6 +143534,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Delete a webhook endpoint get: description:

    Retrieves the webhook endpoint with the given ID.

    operationId: GetWebhookEndpointsWebhookEndpoint @@ -138449,6 +143579,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Retrieve a webhook endpoint post: description: >-

    Updates the webhook endpoint. You may edit the url, the @@ -138621,6 +143752,7 @@ paths: - issuing_token.created - issuing_token.updated - issuing_transaction.created + - issuing_transaction.purchase_details_receipt_updated - issuing_transaction.updated - mandate.updated - payment_intent.amount_capturable_updated @@ -138664,6 +143796,7 @@ paths: - radar.early_fraud_warning.created - radar.early_fraud_warning.updated - refund.created + - refund.failed - refund.updated - reporting.report_run.failed - reporting.report_run.succeeded @@ -138781,6 +143914,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + summary: Update a webhook endpoint security: - basicAuth: [] - bearerAuth: [] diff --git a/packages/openapi-typescript/src/index.ts b/packages/openapi-typescript/src/index.ts index 2875f837a..d7cbb8e27 100644 --- a/packages/openapi-typescript/src/index.ts +++ b/packages/openapi-typescript/src/index.ts @@ -80,6 +80,7 @@ export default async function openapiTS( exportType: options.exportType ?? false, immutable: options.immutable ?? false, rootTypes: options.rootTypes ?? false, + rootTypesNoSchemaPrefix: options.rootTypesNoSchemaPrefix ?? false, injectFooter: [], pathParamsAsTypes: options.pathParamsAsTypes ?? false, postTransform: typeof options.postTransform === "function" ? options.postTransform : undefined, diff --git a/packages/openapi-typescript/src/transform/components-object.ts b/packages/openapi-typescript/src/transform/components-object.ts index 32b12fd7c..47a5a8f71 100644 --- a/packages/openapi-typescript/src/transform/components-object.ts +++ b/packages/openapi-typescript/src/transform/components-object.ts @@ -29,7 +29,6 @@ const transformers: Record { headers: never; pathItems: never; }`, + options: DEFAULT_OPTIONS, }, - // options: DEFAULT_OPTIONS, ], [ "options > alphabetize: true", @@ -699,6 +699,67 @@ export type PathItemUploadUser = components['pathItems']['UploadUser'];`, options: { ...DEFAULT_OPTIONS, rootTypes: true }, }, ], + [ + "options > rootTypes: true and rootTypesNoSchemaPrefix: true", + { + given: { + schemas: { + Item: { + type: "object", + required: ["name", "url"], + properties: { + name: { type: "string" }, + url: { type: "string" }, + }, + }, + Document: { + type: "object", + required: ["name", "size", "url"], + properties: { + name: { type: "string" }, + size: { type: "number" }, + url: { type: "string" }, + }, + }, + Error: { + type: "object", + required: ["code", "message"], + properties: { + code: { type: "string" }, + message: { type: "string" }, + }, + }, + }, + }, + want: `{ + schemas: { + Item: { + name: string; + url: string; + }; + Document: { + name: string; + size: number; + url: string; + }; + Error: { + code: string; + message: string; + }; + }; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} +export type Item = components['schemas']['Item']; +export type Document = components['schemas']['Document']; +export type Error = components['schemas']['Error']; +`, + options: { ...DEFAULT_OPTIONS, rootTypes: true, rootTypesNoSchemaPrefix: true }, + }, + ], [ "transform > with transform object", { @@ -790,11 +851,12 @@ export type PathItemUploadUser = components['pathItems']['UploadUser'];`, headers: never; pathItems: never; }`, + options: DEFAULT_OPTIONS, }, ], ]; - for (const [testName, { given, want, options = DEFAULT_OPTIONS, ci }] of tests) { + for (const [testName, { given, want, options, ci }] of tests) { test.skipIf(ci?.skipIf)( testName, async () => { @@ -802,7 +864,7 @@ export type PathItemUploadUser = components['pathItems']['UploadUser'];`, if (want instanceof URL) { expect(result).toMatchFileSnapshot(fileURLToPath(want)); } else { - expect(result).toBe(`${want}\n`); + expect(result.trim()).toBe(want.trim()); } }, ci?.timeout,